Interface AsukaCameraApi

Simple camera helpers exposed through designer.util.camera.

interface AsukaCameraApi {
    clear: ((elementId: string, variationId: string) => boolean);
    get: (() => null | AsukaCameraView);
    getLimits: (() => null | AsukaCameraLimits);
    getSaved: ((elementId: string, variationId: string) => null | AsukaCameraView);
    load: ((elementId: string, variationId: string, options?: AsukaCameraMoveOptions) => null | AsukaCameraView);
    save: ((elementId: string, variationId: string) => null | AsukaCameraView);
    set: ((view: Partial<AsukaCameraView>, options?: AsukaCameraMoveOptions) => null | AsukaCameraView);
    setLimits: ((limits: Partial<AsukaCameraLimits>) => null | AsukaCameraLimits);
}

Properties

clear: ((elementId: string, variationId: string) => boolean)

Remove the camera preset from one variation.

get: (() => null | AsukaCameraView)

Read the active 3D camera. Returns null outside a mounted 3D view.

getLimits: (() => null | AsukaCameraLimits)

Read the active view orbit limits.

getSaved: ((elementId: string, variationId: string) => null | AsukaCameraView)

Read the camera preset stored on one variation.

load: ((elementId: string, variationId: string, options?: AsukaCameraMoveOptions) => null | AsukaCameraView)

Load the camera preset stored on one variation.

save: ((elementId: string, variationId: string) => null | AsukaCameraView)

Capture the current camera and save it on one variation.

Move the active 3D camera.

setLimits: ((limits: Partial<AsukaCameraLimits>) => null | AsukaCameraLimits)

Update and persist the active view orbit limits.