Interface AsukaAssemblyApi

Generic spatial-assembly operations exposed through AsukaDesigner.assembly.

The contract uses serializable transforms, anchors, rules, BOM lines and validation results. Native Babylon objects never cross this boundary.

interface AsukaAssemblyApi {
    applyMaterialPreset: ((surfaceId: string, presetId: string, applyOptions?: AsukaAssemblyMaterialApplyOptions, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>);
    autoPlace: ((componentId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyPlacementResult>);
    cancelDrawing: (() => void);
    clearSurfaces: ((options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyState>);
    configure: ((patch: Partial<AsukaAssemblyState>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyState>);
    connect: ((connection: Partial<AsukaAssemblyConnection>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyConnection>);
    disconnect: ((connectionId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyConnection>);
    export: ((kind: AsukaAssemblyExportKind, options?: AsukaAssemblyExportOptions) => Promise<Blob>);
    getBom: ((options?: {
        currency?: string;
    }) => AsukaAssemblyBom);
    getBuildState: (() => AsukaAssemblyBuildState);
    getComponent: ((id: string) => null | AsukaAssemblyComponent);
    getInteractionState: (() => AsukaAssemblyInteractionState);
    getQuote: ((options?: AsukaAssemblyQuoteOptions) => AsukaAssemblyQuote);
    getState: (() => AsukaAssemblyState);
    getSurfaceMetrics: ((id: string) => null | AsukaAssemblyFloorMetrics);
    getSurfaceTransform: ((id: string) => null | AsukaAssemblySurfaceTransform);
    linkStack: ((link: Partial<AsukaAssemblyStackLink>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyStackLink>);
    listComponents: (() => AsukaAssemblyComponent[]);
    listMaterialPresets: (() => AsukaAssemblyMaterialPreset[]);
    listStackLinks: (() => AsukaAssemblyStackLink[]);
    listSurfaces: (() => AsukaAssemblySurface[]);
    place: ((componentId: string, input?: AsukaAssemblyPlacementInput, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyPlacementResult>);
    previewPlacement: ((componentId: string, input?: AsukaAssemblyPlacementInput) => AsukaAssemblyPlacementResult);
    removeMaterialPreset: ((presetId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<boolean>);
    removeSurface: ((id: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>);
    saveMaterialPreset: ((preset: Partial<AsukaAssemblyMaterialPreset>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyMaterialPreset>);
    selectSurface: ((id: null | string) => null | AsukaAssemblySurface);
    setConstructionMode: ((active: boolean) => AsukaAssemblyInteractionState);
    setFloorEdgeAngle: ((floorId: string, edgeIndex: number, angleDegrees: number, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>);
    setFloorEdgeConstraint: ((floorId: string, edgeIndex: number, constraint: AsukaAssemblyFloorEdgeConstraint, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>);
    setFloorEdgeLength: ((floorId: string, edgeIndex: number, length: number, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>);
    setMoveTool: ((active: boolean) => AsukaAssemblyInteractionState);
    setRoomWallEnabled: ((floorId: string, edgeIndex: number, enabled: boolean, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>);
    startDrawing: ((input: AsukaAssemblyStartDrawingInput) => void);
    transformSurface: ((id: string, input: AsukaAssemblySurfaceTransformInput, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>);
    unlinkStack: ((linkId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyStackLink>);
    updateSurface: ((id: string, patch: AsukaAssemblySurfacePatch, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>);
    validate: (() => AsukaAssemblyValidation);
}

Properties

applyMaterialPreset autoPlace cancelDrawing clearSurfaces configure connect disconnect export getBom getBuildState getComponent getInteractionState getQuote getState getSurfaceMetrics getSurfaceTransform linkStack listComponents listMaterialPresets listStackLinks listSurfaces place previewPlacement removeMaterialPreset removeSurface saveMaterialPreset selectSurface setConstructionMode setFloorEdgeAngle setFloorEdgeConstraint setFloorEdgeLength setMoveTool setRoomWallEnabled startDrawing transformSurface unlinkStack updateSurface validate

Properties

applyMaterialPreset

applyMaterialPreset: ((surfaceId: string, presetId: string, applyOptions?: AsukaAssemblyMaterialApplyOptions, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>)

Apply a reusable material to a face, surface or complete room.

autoPlace

autoPlace: ((componentId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyPlacementResult>)

Find the nearest compatible anchor or valid plan position automatically.

cancelDrawing

cancelDrawing: (() => void)

Stop the active mouse construction tool.

clearSurfaces

clearSurfaces: ((options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyState>)

Remove every explicitly drawn floor and wall.

configure

configure: ((patch: Partial<AsukaAssemblyState>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyState>)

Configure the room/plan and placement policies for the active 3D view.

connect

connect: ((connection: Partial<AsukaAssemblyConnection>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyConnection>)

Create an explicit connection between two compatible anchors.

disconnect

disconnect: ((connectionId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyConnection>)

Remove one persisted anchor connection.

export

export: ((kind: AsukaAssemblyExportKind, options?: AsukaAssemblyExportOptions) => Promise<Blob>)

Export BOM CSV/JSON, quote JSON or a complete production package.

getBom

getBom: ((options?: {
    currency?: string;
}) => AsukaAssemblyBom)

Build the normalized bill of materials for the current assembly.

getBuildState

getBuildState: (() => AsukaAssemblyBuildState)

Return the active mouse construction tool and selected surface.

getComponent

getComponent: ((id: string) => null | AsukaAssemblyComponent)

Return one assembly component by runtime product id.

getInteractionState

getInteractionState: (() => AsukaAssemblyInteractionState)

Return the active novice-friendly placement tool.

getQuote

getQuote: ((options?: AsukaAssemblyQuoteOptions) => AsukaAssemblyQuote)

Build a quote from BOM pricing and optional adjustments.

getState

getState: (() => AsukaAssemblyState)

Return the persisted plan, snapping settings and current connections.

getSurfaceMetrics

getSurfaceMetrics: ((id: string) => null | AsukaAssemblyFloorMetrics)

Measure one floor outline in renderer world units.

getSurfaceTransform

getSurfaceTransform: ((id: string) => null | AsukaAssemblySurfaceTransform)

Read the absolute center and orientation of one floor or wall.

linkStack

linkStack: ((link: Partial<AsukaAssemblyStackLink>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyStackLink>)

Center one component above another and keep their widths synchronized.

listComponents

listComponents: (() => AsukaAssemblyComponent[])

List every assembly-enabled Product 3D instance in the active view.

listMaterialPresets

listMaterialPresets: (() => AsukaAssemblyMaterialPreset[])

List built-in and user-created reusable surface materials.

listStackLinks

listStackLinks: (() => AsukaAssemblyStackLink[])

List vertical instance links in the active 3D view.

listSurfaces

listSurfaces: (() => AsukaAssemblySurface[])

List the floors and walls explicitly created in build mode.

place

place: ((componentId: string, input?: AsukaAssemblyPlacementInput, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<AsukaAssemblyPlacementResult>)

Place a component, applying the last valid transform when required.

previewPlacement

previewPlacement: ((componentId: string, input?: AsukaAssemblyPlacementInput) => AsukaAssemblyPlacementResult)

Evaluate snapping, collisions, clearances and adjacency without mutating.

removeMaterialPreset

removeMaterialPreset: ((presetId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<boolean>)

Remove a user-created reusable surface material.

removeSurface

removeSurface: ((id: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>)

Remove one floor or wall.

saveMaterialPreset

saveMaterialPreset: ((preset: Partial<AsukaAssemblyMaterialPreset>, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyMaterialPreset>)

Create or replace a reusable surface material.

selectSurface

selectSurface: ((id: null | string) => null | AsukaAssemblySurface)

Select one floor or wall for appearance editing.

setConstructionMode

setConstructionMode: ((active: boolean) => AsukaAssemblyInteractionState)

Enter or leave the persistent guided construction session.

setFloorEdgeAngle

setFloorEdgeAngle: ((floorId: string, edgeIndex: number, angleDegrees: number, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>)

Set one floor edge angle while preserving its length.

setFloorEdgeConstraint

setFloorEdgeConstraint: ((floorId: string, edgeIndex: number, constraint: AsukaAssemblyFloorEdgeConstraint, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>)

Lock or unlock the exact length and angle of one stable floor edge.

setFloorEdgeLength

setFloorEdgeLength: ((floorId: string, edgeIndex: number, length: number, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>)

Set one floor edge length while keeping its direction and stable corner ids.

setMoveTool

setMoveTool: ((active: boolean) => AsukaAssemblyInteractionState)

Enable regular drag placement without requiring the Ctrl modifier.

setRoomWallEnabled

setRoomWallEnabled: ((floorId: string, edgeIndex: number, enabled: boolean, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyFloorSurface>)

Add or remove the wall linked to one stable room edge.

startDrawing

startDrawing: ((input: AsukaAssemblyStartDrawingInput) => void)

Start a mouse tool for selecting, drawing or erasing surfaces.

transformSurface

transformSurface: ((id: string, input: AsukaAssemblySurfaceTransformInput, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>)

Move or rotate a complete floor or wall without changing its dimensions.

unlinkStack

unlinkStack: ((linkId: string, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblyStackLink>)

Remove a vertical instance link without deleting either component.

updateSurface

updateSurface: ((id: string, patch: AsukaAssemblySurfacePatch, options?: AsukaAssemblyMutationOptions) => AsukaMutationPromise<null | AsukaAssemblySurface>)

Update geometry or appearance for one floor or wall.

validate

validate: (() => AsukaAssemblyValidation)

Validate the whole scene against collision, clearance and adjacency rules.

Settings

Member Visibility

On This Page

Properties