Interface AsukaRenderEngineAreas

interface AsukaRenderEngineAreas {
    cancelDrawing?(): void;
    cancelFacePicking?(): void;
    cancelPickForAdd?(): void;
    classifyMesh?(meshId: string): unknown;
    constrain(objectId: string, printAreaId?: null | string, options?: AsukaPrintAreaConstraintOptions): AsukaMutationPromise<AsukaPrintAreaConstraintStatus>;
    contains(objectId: string, printAreaId?: null | string, options?: AsukaPrintAreaConstraintOptions): AsukaPrintAreaConstraintStatus;
    create(input?: AsukaPrintAreaInput): AsukaMutationPromise<null | AsukaPrintArea>;
    focus(id: string): void | Promise<void>;
    get(id: string): null | AsukaPrintArea;
    getActive(): null | AsukaPrintArea;
    getBounds(id: string): null | AsukaBoundsBox;
    list(): AsukaPrintArea[];
    moveObject(objectId: string, delta: Partial<AsukaObjectTransform> & AsukaObjectPatch, options?: AsukaPrintAreaConstraintOptions): AsukaMutationPromise<AsukaPrintAreaConstraintStatus>;
    pickForAdd(): Promise<null | string>;
    remove(id: string): AsukaMutationPromise<null | AsukaPrintArea>;
    select(id: null | string): void;
    startDrawing?(input?: {
        id?: string;
        label?: string;
        metadata?: Record<string, unknown>;
        onCancel?: (() => void);
        onCreate?: ((area: Asuka3DPrintArea) => void);
        physicalSize?: AsukaPhysicalSize;
        targetMeshId?: string;
    }): void;
    startFacePicking?(input?: {
        faces?: string[];
        onCancel?: (() => void);
        onChange?: ((selection: {
            faces: string[];
            meshId?: string;
            normal?: [number, number, number];
            pickedFace: string;
            point?: [number, number, number];
            primaryFace: string;
        }) => void);
        primaryFace?: string;
        targetMeshId?: string;
    }): void;
    transformObject(objectId: string, patch: Partial<AsukaObjectTransform> & AsukaObjectPatch, options?: AsukaPrintAreaConstraintOptions): AsukaMutationPromise<AsukaPrintAreaConstraintStatus>;
    update(id: string, patch: AsukaPrintAreaPatch): AsukaMutationPromise<null | AsukaPrintArea>;
}

Methods

cancelDrawing? cancelFacePicking? cancelPickForAdd? classifyMesh? constrain contains create focus get getActive getBounds list moveObject pickForAdd remove select startDrawing? startFacePicking? transformObject update

Methods

OptionalcancelDrawing

  • cancelDrawing(): void

  • Returns void

OptionalcancelFacePicking

  • cancelFacePicking(): void

  • Returns void

OptionalcancelPickForAdd

  • cancelPickForAdd(): void

  • Returns void

OptionalclassifyMesh

  • classifyMesh(meshId): unknown

  • Parameters

    • meshId: string

    Returns unknown

constrain

contains

create

focus

  • focus(id): void | Promise<void>

  • Parameters

    • id: string

    Returns void | Promise<void>

get

getActive

getBounds

list

moveObject

pickForAdd

  • pickForAdd(): Promise<null | string>

  • Returns Promise<null | string>

remove

select

  • select(id): void

  • Parameters

    • id: null | string

    Returns void

OptionalstartDrawing

  • startDrawing(input?): void

  • Parameters

    • Optionalinput: {
          id?: string;
          label?: string;
          metadata?: Record<string, unknown>;
          onCancel?: (() => void);
          onCreate?: ((area: Asuka3DPrintArea) => void);
          physicalSize?: AsukaPhysicalSize;
          targetMeshId?: string;
      }
      • Optionalid?: string
      • Optionallabel?: string
      • Optionalmetadata?: Record<string, unknown>
      • OptionalonCancel?: (() => void)
          • (): void

          • Returns void

      • OptionalonCreate?: ((area: Asuka3DPrintArea) => void)
      • OptionalphysicalSize?: AsukaPhysicalSize
      • OptionaltargetMeshId?: string

    Returns void

OptionalstartFacePicking

  • startFacePicking(input?): void

  • Parameters

    • Optionalinput: {
          faces?: string[];
          onCancel?: (() => void);
          onChange?: ((selection: {
              faces: string[];
              meshId?: string;
              normal?: [number, number, number];
              pickedFace: string;
              point?: [number, number, number];
              primaryFace: string;
          }) => void);
          primaryFace?: string;
          targetMeshId?: string;
      }
      • Optionalfaces?: string[]
      • OptionalonCancel?: (() => void)
          • (): void

          • Returns void

      • OptionalonChange?: ((selection: {
            faces: string[];
            meshId?: string;
            normal?: [number, number, number];
            pickedFace: string;
            point?: [number, number, number];
            primaryFace: string;
        }) => void)
          • (selection): void

          • Parameters

            • selection: {
                  faces: string[];
                  meshId?: string;
                  normal?: [number, number, number];
                  pickedFace: string;
                  point?: [number, number, number];
                  primaryFace: string;
              }
              • faces: string[]
              • OptionalmeshId?: string
              • Optionalnormal?: [number, number, number]
              • pickedFace: string
              • Optionalpoint?: [number, number, number]
              • primaryFace: string

            Returns void

      • OptionalprimaryFace?: string
      • OptionaltargetMeshId?: string

    Returns void

transformObject

update

Settings

Member Visibility

On This Page

Methods