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<CameraViewPluginEventMap>
- CameraViewPlugin

Constructors

constructor

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

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (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" | "spline" = 'spherical'

isViewerPluginSync

isViewerPluginSync: true = ...

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:101

animationLooping

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

cameraViews

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

camViews

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

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_postFrame

_postFrame(): undefined | true
Returns undefined | true
- Defined in src/plugins/animation/CameraViewPlugin.ts:572

`Protected`_storeKey

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

`Protected`_viewAnimateView

_viewAnimateView(
    __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;
    },
): Promise<void>
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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:525

`Protected`_viewDeleteView

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

`Protected`_viewSetView

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

`Protected`_viewUpdated

_viewUpdated(e: { key?: string; target: ICameraView }): Promise<void>
Parameters
- e: { key?: string; target: ICameraView }
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:533

`Protected`_viewUpdateView

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

addCurrentView

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

addView

addView(view: CameraView, force?: boolean): void
Parameters
- view: CameraView
- force: boolean = false
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:162

animateAllViews

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

animateToFitObject

animateToFitObject(
    selected?:
        | IMaterial<IMaterialEventMap>
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
        | IMaterial<IMaterialEventMap>[]
        | ITexture<TextureEventMap>
        | Object3D<Object3DEventMap>
        | Object3D<Object3DEventMap>[]
        | ITexture<TextureEventMap>[]
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[],
    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>
Animates the camera to fit the selected objects in the viewport. When duration is 0, the view is set instantly via ICamera.fitObject. Accepts Object3D, materials, textures, or geometries (resolved to their applied meshes).
Parameters
- Optionalselected:
      | IMaterial<IMaterialEventMap>
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
      | IMaterial<IMaterialEventMap>[]
      | ITexture<TextureEventMap>
      | Object3D<Object3DEventMap>
      | Object3D<Object3DEventMap>[]
      | ITexture<TextureEventMap>[]
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]
  objects to fit. Falls back to the scene model root.
- distanceMultiplier: number = 1.5
  padding multiplier on the fitting distance (default 1.5)
- Optionalduration: number
  animation duration in ms. Pass 0 for instant. Defaults to animDuration.
- Optionalease:
      | Easing
      | "linear"
      | "easeIn"
      | "easeOut"
      | "easeInOut"
      | "circIn"
      | "circOut"
      | "circInOut"
      | "backIn"
      | "backOut"
      | "backInOut"
      | "anticipate"
      | "bounceOut"
      | "bounceIn"
      | "bounceInOut"
      | "easeInOutSine"
  easing function or name
- distanceBounds: { max: number; min: number } = ...
  min/max clamp on the final distance
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:422

animateToObject

animateToObject(
    selected?: Object3D<Object3DEventMap>,
    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<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>
- Defined in src/plugins/animation/CameraViewPlugin.ts:392

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:453

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<ICameraEventMap>,
    throwOnStop?: boolean,
    normalizeDuration?: 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<ICameraEventMap>
- throwOnStop: boolean = false
- OptionalnormalizeDuration: boolean
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:228

deleteView

deleteView(view: CameraView, force?: boolean): void
Parameters
- view: CameraView
- force: boolean = false
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:176

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

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

focusNext

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

focusPrevious

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

focusView

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

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:377

getCurrentCameraView

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

getView

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

resetToFirstView

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

setCurrentCameraView

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

setDirty

setDirty(ops?: any): any
Parameters
- Optionalops: any
Returns any
Overrides AViewerPluginSync.setDirty
- Defined in src/plugins/animation/CameraViewPlugin.ts:387

setView

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

stopAllAnimations

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

toJSON

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

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

isViewerPluginSync

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_postFrame

Returns undefined | true

Protected_storeKey

Parameters

Returns string

Protected_viewAnimateView

Parameters

Returns Promise<void>

Protected_viewDeleteView

Parameters

Returns void

Protected_viewSetView

Parameters

Returns void

Protected_viewUpdated

Parameters

Returns Promise<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

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_postFrame

`Protected`_storeKey

`Protected`_viewAnimateView

`Protected`_viewDeleteView

`Protected`_viewSetView

`Protected`_viewUpdated

`Protected`_viewUpdateView