ThreePipe
    Preparing search index...

    Class CameraViewPlugin

    Camera View Plugin

    Provides API to save, interact and animate and loop between with multiple camera states/views using the PopmotionPlugin.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _dirty: boolean = false
    _viewer?: ThreeViewer
    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    animDuration: number = 1000
    animEase:
        | "linear"
        | "easeIn"
        | "easeOut"
        | "easeInOut"
        | "circIn"
        | "circOut"
        | "circInOut"
        | "backIn"
        | "backOut"
        | "backInOut"
        | "anticipate"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut"
        | "easeInOutSine" = 'easeInOutSine'
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    dependencies: typeof PopmotionPlugin[] = ...
    enabled: boolean = true
    interpolateMode: "linear" | "spherical" | "spline" = 'spherical'
    rotationOffset: number = 0.25
    uiConfig: UiObjectConfig = ...
    viewLooping: boolean = false
    viewPauseTime: number = 200

    Pauses time between view changes when animating all views or looping.

    OldPluginType?: string
    PluginType: "CameraViews" = 'CameraViews'

    Accessors

    Methods

    • Parameters

      • __namedParameters: {
            camera?: ICamera<ICameraEventMap>;
            duration?: number;
            easing?:
                | Easing
                | "linear"
                | "easeIn"
                | "easeOut"
                | "easeInOut"
                | "circIn"
                | "circOut"
                | "circInOut"
                | "backIn"
                | "backOut"
                | "backInOut"
                | "anticipate"
                | "bounceOut"
                | "bounceIn"
                | "bounceInOut"
                | "easeInOutSine";
            throwOnStop?: boolean;
            view: CameraView;
        }

      Returns Promise<void>

    • Parameters

      • Optionalselected: Object3D<Object3DEventMap>
      • distanceMultiplier: number = 4
      • Optionalduration: number
      • Optionalease:
            | Easing
            | "linear"
            | "easeIn"
            | "easeOut"
            | "easeInOut"
            | "circIn"
            | "circOut"
            | "circInOut"
            | "backIn"
            | "backOut"
            | "backInOut"
            | "anticipate"
            | "bounceOut"
            | "bounceIn"
            | "bounceInOut"
            | "easeInOutSine"
      • distanceBounds: { max: number; min: number } = ...

      Returns Promise<void>

    • Parameters

      • distanceFromTarget: number

        in world units

      • center: Vector3

        target (center) of the view in world coordinates

      • Optionalduration: number

        in milliseconds

      • Optionalease:
            | Easing
            | "linear"
            | "easeIn"
            | "easeOut"
            | "easeInOut"
            | "circIn"
            | "circOut"
            | "circInOut"
            | "backIn"
            | "backOut"
            | "backInOut"
            | "anticipate"
            | "bounceOut"
            | "bounceIn"
            | "bounceInOut"
            | "easeInOutSine"

      Returns Promise<void>

    • Parameters

      • _view: string | number | CameraView
      • Optionalduration: number
      • Optionaleasing:
            | Easing
            | "linear"
            | "easeIn"
            | "easeOut"
            | "easeInOut"
            | "circIn"
            | "circOut"
            | "circInOut"
            | "backIn"
            | "backOut"
            | "backInOut"
            | "anticipate"
            | "bounceOut"
            | "bounceIn"
            | "bounceInOut"
            | "easeInOutSine"
      • Optionalcamera: ICamera<ICameraEventMap>
      • throwOnStop: boolean = false

      Returns Promise<void>