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 full)

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

Constructors

constructor

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

Properties

`Private` _animating

_animating: boolean = false

`Private` _animationLooping

_animationLooping: boolean = false

`Private` _cameraViews

_cameraViews: CameraView[] = []

`Private` _currentView

_currentView: undefined | CameraView

`Protected` _dirty

_dirty: boolean = false

`Private` _infiniteLooping

_infiniteLooping: boolean = true

`Private` _popAnimations

_popAnimations: AnimationResult[] = []

`Private` _viewQueue

_viewQueue: CameraView[] = []

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns 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<any, string, any> = ...

viewLooping

viewLooping: boolean = false

viewPauseTime

viewPauseTime: number = 200

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

`Static` `Readonly` PluginType

PluginType: "CameraViews" = 'CameraViews'

Accessors

animating

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

animationLooping

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

camViews

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

cameraViews

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

dirty

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

Methods

`Private` _animationLoop

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

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

`Protected` _viewAnimateView

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

`Protected` _viewDeleteView

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

`Protected` _viewSetView

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

`Protected` _viewUpdateView

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

addCurrentView

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

addView

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

animateAllViews

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

animateToFitObject

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

animateToObject

animateToObject(selected?, distanceMultiplier?, duration?, ease?, distanceBounds?): Promise<void>
Parameters
- Optional selected: Object3D<Event, string>
- distanceMultiplier: number = 4
- Optional duration: number
- Optional ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"
- distanceBounds: {
  max: number;
  min: number;
  } = ...
  - max: number
  - min: number
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:312

animateToTarget

animateToTarget(distanceFromTarget, center, duration?, ease?): Promise<void>
Parameters
- distanceFromTarget: number
  in world units
- center: Vector3
  target (center) of the view in world coordinates
- Optional duration: number
  in milliseconds
- Optional ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"
Returns Promise<void>
- Defined in src/plugins/animation/CameraViewPlugin.ts:349

animateToView

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

deleteView

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

disable

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

dispose

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

enable

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

exportState

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

focusNext

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

focusPrevious

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

focusView

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

fromJSON

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

getCurrentCameraView

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

getView

getView(camera?, worldSpace?, view?): CameraView
Parameters
- Optional camera: ICamera<ICameraEvent, ICameraEventTypes>
- worldSpace: boolean = true
- Optional view: CameraView
Returns CameraView
- Defined in src/plugins/animation/CameraViewPlugin.ts:192

importState

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

isDisabled

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

onAdded

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

onRemove

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

resetToFirstView

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

setCurrentCameraView

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

`Optional` setDirty

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

setView

setView(view, camera?): void
Parameters
- view: ICameraView
- Optional camera: ICamera<ICameraEvent, ICameraEventTypes>
Returns void
- Defined in src/plugins/animation/CameraViewPlugin.ts:198

stopAllAnimations

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

toJSON

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

Class CameraViewPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: CameraViewPluginOptions = {}

Returns CameraViewPlugin

Properties

Private _animating

Private _animationLooping

Private _cameraViews

Private _currentView

Protected _dirty

Private _infiniteLooping

Private _popAnimations

Private _viewQueue

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

animDuration

animEase

constructor

dependencies

enabled

interpolateMode

rotationOffset

uiConfig

viewLooping

viewPauseTime

Static Readonly PluginType

Accessors

animating

Returns boolean

animationLooping

Returns boolean

camViews

Returns CameraView[]

cameraViews

Returns CameraView[]

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _animationLoop

Returns Promise<void>

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

Protected _viewAnimateView

Parameters

Optional camera?: ICamera<ICameraEvent, ICameraEventTypes>

Optional duration?: number

Optional easing?: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

Optional throwOnStop?: boolean

view: CameraView

Returns Promise<void>

Protected _viewDeleteView

Parameters

__namedParameters: { view: CameraView; }

view: CameraView

Returns void

Protected _viewSetView

Parameters

__namedParameters: { camera?: ICamera<ICameraEvent, ICameraEventTypes>; view?: CameraView; }

Optional camera?: ICamera<ICameraEvent, ICameraEventTypes>

`Private` _animating

`Private` _animationLooping

`Private` _cameraViews

`Private` _currentView

`Protected` _dirty

`Private` _infiniteLooping

`Private` _popAnimations

`Private` _viewQueue

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Static` `Readonly` PluginType

`Private` _animationLoop

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Protected` _viewAnimateView

`Optional` camera?: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` duration?: number

`Optional` easing?: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

`Optional` throwOnStop?: boolean

`Protected` _viewDeleteView

__namedParameters: {
view: CameraView;
}

`Protected` _viewSetView

__namedParameters: {
camera?: ICamera<ICameraEvent, ICameraEventTypes>;
view?: CameraView;
}

`Optional` camera?: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` view?: CameraView

`Protected` _viewUpdateView

__namedParameters: {
camera?: ICamera<ICameraEvent, ICameraEventTypes>;
view: CameraView;
}

`Optional` camera?: ICamera<ICameraEvent, ICameraEventTypes>

`Optional` selected: Object3D<Event, string>

`Optional` ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

distanceBounds: {
max: number;
min: number;
} = ...

`Optional` selected: Object3D<Event, string>

`Optional` duration: number

`Optional` ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

distanceBounds: {
max: number;
min: number;
} = ...

`Optional` duration: number

`Optional` ease: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

`Optional` duration: number

`Optional` easing: "linear" | Easing | "easeIn" | "easeOut" | "easeInOut" | "circIn" | "circOut" | "circInOut" | "backIn" | "backOut" | "backInOut" | "anticipate" | "bounceOut" | "bounceIn" | "bounceInOut" | "easeInOutSine"

`Optional` camera: ICamera<ICameraEvent, ICameraEventTypes>