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)

AViewerPluginSync<"viewChange" | "startViewChange" | "viewAdd" | "viewDelete">
- CameraViewPlugin

Constructors

constructor

new CameraViewPlugin(options?: CameraViewPluginOptions): CameraViewPlugin
Parameters
- options: CameraViewPluginOptions = {}
Returns CameraViewPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/animation/CameraViewPlugin.ts:30

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

animDuration

animDuration: number = 1000

animEase

EasingFunctions

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PopmotionPlugin[] = ...

enabled

enabled: boolean = true

interpolateMode

interpolateMode: "linear" | "spherical" = 'spherical'

rotationOffset

rotationOffset: number = 0.25

uiConfig

uiConfig: UiObjectConfig = ...

viewLooping

viewLooping: boolean = false

viewPauseTime

viewPauseTime: number = 200

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "CameraViews" = 'CameraViews'

Accessors

animating

get animating(): boolean
Returns boolean
- Defined in src/plugins/animation/CameraViewPlugin.ts:81

animationLooping

get animationLooping(): boolean
Returns boolean
- Defined in src/plugins/animation/CameraViewPlugin.ts:372

cameraViews

get cameraViews(): CameraView[]
Returns CameraView[]
- Defined in src/plugins/animation/CameraViewPlugin.ts:49

camViews

get camViews(): CameraView[]
Returns CameraView[]
- Defined in src/plugins/animation/CameraViewPlugin.ts:52

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

`Protected`_viewAnimateView

_viewAnimateView(
    __namedParameters: {
        camera?: ICamera;
        duration?: number;
        easing?:
            | Easing
            | "linear"
            | "easeIn"
            | "easeOut"
            | "easeInOut"
            | "circIn"
            | "circOut"
            | "circInOut"
            | "backIn"
            | "backOut"
            | "backInOut"
            | "anticipate"
            | "bounceOut"
            | "bounceIn"
            | "bounceInOut"
            | "easeInOutSine";
        throwOnStop?: boolean;
        view: CameraView;
    },
): Promise<void>
Parameters
- __namedParameters: {
      camera?: ICamera;
      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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:178

`Protected`_viewDeleteView

_viewDeleteView(__namedParameters: { view: CameraView }): void
Parameters
- __namedParameters: { view: CameraView }
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:170

`Protected`_viewSetView

_viewSetView(__namedParameters: { camera?: ICamera; view?: CameraView }): void
Parameters
- __namedParameters: { camera?: ICamera; view?: CameraView }
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:152

`Protected`_viewUpdateView

_viewUpdateView(__namedParameters: { camera?: ICamera; view: CameraView }): void
Parameters
- __namedParameters: { camera?: ICamera; view: CameraView }
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:160

addCurrentView

addCurrentView(): Promise<undefined | CameraView>
Returns Promise<undefined | CameraView>
- Defined in src/plugins/animation/CameraViewPlugin.ts:132

addView

addView(view: CameraView): void
Parameters
- view: CameraView
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:142

animateAllViews

animateAllViews(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:299

animateToFitObject

animateToFitObject(
    selected?: Object3D,
    distanceMultiplier?: number,
    duration?: number,
    ease?:
        | Easing
        | "linear"
        | "easeIn"
        | "easeOut"
        | "easeInOut"
        | "circIn"
        | "circOut"
        | "circInOut"
        | "backIn"
        | "backOut"
        | "backInOut"
        | "anticipate"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut"
        | "easeInOutSine",
    distanceBounds?: { max: number; min: number },
): Promise<void>
Parameters
- Optionalselected: Object3D
- distanceMultiplier: number = 1.5
- duration: number = 1000
- 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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:339

animateToObject

animateToObject(
    selected?: Object3D,
    distanceMultiplier?: number,
    duration?: number,
    ease?:
        | Easing
        | "linear"
        | "easeIn"
        | "easeOut"
        | "easeInOut"
        | "circIn"
        | "circOut"
        | "circInOut"
        | "backIn"
        | "backOut"
        | "backInOut"
        | "anticipate"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut"
        | "easeInOutSine",
    distanceBounds?: { max: number; min: number },
): Promise<void>
Parameters
- Optionalselected: Object3D
- 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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:330

animateToTarget

animateToTarget(
    distanceFromTarget: number,
    center: Vector3,
    duration?: number,
    ease?:
        | Easing
        | "linear"
        | "easeIn"
        | "easeOut"
        | "easeInOut"
        | "circIn"
        | "circOut"
        | "circInOut"
        | "backIn"
        | "backOut"
        | "backInOut"
        | "anticipate"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut"
        | "easeInOutSine",
): 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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:354

animateToView

animateToView(
    _view: string | number | CameraView,
    duration?: number,
    easing?:
        | Easing
        | "linear"
        | "easeIn"
        | "easeOut"
        | "easeInOut"
        | "circIn"
        | "circOut"
        | "circInOut"
        | "backIn"
        | "backOut"
        | "backInOut"
        | "anticipate"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut"
        | "easeInOutSine",
    camera?: ICamera,
    throwOnStop?: boolean,
): 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
- throwOnStop: boolean = false
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:235

deleteView

deleteView(view: CameraView): void
Parameters
- view: CameraView
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:186

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

focusNext

focusNext(wrap?: boolean): void
Parameters
- wrap: boolean = true
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:212

focusPrevious

focusPrevious(wrap?: boolean): void
Parameters
- wrap: boolean = true
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:222

focusView

focusView(view: CameraView): Promise<void>
Parameters
- view: CameraView
Returns Promise<void>
Deprecated
- use animateToView instead
- Defined in src/plugins/animation/CameraViewPlugin.ts:418

fromJSON

fromJSON(data: any, meta?: any): null | CameraViewPlugin
Parameters
- data: any
- Optionalmeta: any
Returns null | CameraViewPlugin
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/animation/CameraViewPlugin.ts:320

getCurrentCameraView

getCurrentCameraView(camera?: ICamera, worldSpace?: boolean): CameraView
Parameters
- Optionalcamera: ICamera
- worldSpace: boolean = true
Returns CameraView
Deprecated
- renamed to getView or ICamera.getView
- Defined in src/plugins/animation/CameraViewPlugin.ts:401

getView

getView(camera?: ICamera, worldSpace?: boolean, view?: CameraView): CameraView
Parameters
- Optionalcamera: ICamera
- worldSpace: boolean = true
- Optionalview: CameraView
Returns CameraView
- Defined in src/plugins/animation/CameraViewPlugin.ts:198

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:57

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/animation/CameraViewPlugin.ts:90

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/animation/CameraViewPlugin.ts:114

resetToFirstView

resetToFirstView(duration?: number): Promise<void>
Parameters
- duration: number = 100
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:124

setCurrentCameraView

setCurrentCameraView(view: CameraView): void
Parameters
- view: CameraView
Returns void
Deprecated
- renamed to setView or ICamera.setView
- Defined in src/plugins/animation/CameraViewPlugin.ts:409

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

setView

setView(view: ICameraView, camera?: ICamera): void
Parameters
- view: ICameraView
- Optionalcamera: ICamera
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:204

stopAllAnimations

stopAllAnimations(): Promise<void>
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:311

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

Class CameraViewPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CameraViewPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

animDuration

animEase

constructor

dependencies

enabled

interpolateMode

rotationOffset

uiConfig

viewLooping

viewPauseTime

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

animating

Returns boolean

animationLooping

Returns boolean

cameraViews

Returns CameraView[]

camViews

Returns CameraView[]

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

Protected_viewAnimateView

Parameters

Returns Promise<void>

Protected_viewDeleteView

Parameters

Returns void

Protected_viewSetView

Parameters

Returns void

Protected_viewUpdateView

Parameters

Returns void

addCurrentView

Returns Promise<undefined | CameraView>

addView

Parameters

Returns void

animateAllViews

Returns Promise<void>

animateToFitObject

Parameters

Returns Promise<void>

animateToObject

Parameters

Returns Promise<void>

animateToTarget

Parameters

Returns Promise<void>

animateToView

Parameters

Returns Promise<void>

deleteView

Parameters

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Protected`_viewAnimateView

`Protected`_viewDeleteView

`Protected`_viewSetView

`Protected`_viewUpdateView

`Optional`setDirty