Class CameraPathAnimation

Animates the Scene's's Camera along a CameraPath.

Hierarchy

Component
- CameraPathAnimation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CameraPathAnimation(owner?: Component, cfg?: CameraPathAnimationConfiguration): CameraPathAnimation

Overrides Component.constructor
- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:19
Parameters
- Optional owner: Component
- Optional cfg: CameraPathAnimationConfiguration
Returns CameraPathAnimation

Properties

id

id: string

ID of this Component, unique within the Scene.

Components are mapped by this ID in {@link Scene.components}.

property: id

meta

meta: any

Arbitrary, user-defined metadata on this component.

property: metadata

scene

scene: Scene

The parent Scene that contains this Component.

property: scene
final

viewer

viewer: Viewer

The viewer that contains this Scene.

property: viewer

Accessors

cameraPath

get cameraPath(): CameraPath
set cameraPath(arg: CameraPath): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:33
Gets the CameraPath animated by this CameraPathAnimation.

Returns CameraPath
The CameraPath.
- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:26
Sets the CameraPath animated by this CameraPathAnimation.

Parameters
- arg: CameraPath
Returns void

owner

get owner(): Component

Inherited from Component.owner
- Defined in viewer/scene/Component.d.ts:54
The Component that owns the lifecycle of this Component, if any.

When that component is destroyed, this component will be automatically destroyed also.

Will be null if this Component has no owner.

property
owner

Returns Component

rate

get rate(): number
set rate(arg: number): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:47
Gets the rate at which the CameraPathAnimation animates the Camera along the CameraPath.

Returns number
The current playing rate.
- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:40
Sets the rate at which the CameraPathAnimation animates the Camera along the CameraPath.

Parameters
- arg: number
Returns void

Methods

clear

clear(): void

Inherited from Component.clear
- Defined in viewer/scene/Component.d.ts:149
Destroys all Components that are owned by this. These are Components that were instantiated with this Component as their first constructor argument.

Returns void

destroy

destroy(): void

Inherited from Component.destroy
- Defined in viewer/scene/Component.d.ts:154
Destroys this component.

Returns void

error

error(message: string): void

Inherited from Component.error
- Defined in viewer/scene/Component.d.ts:143
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>

Also fires the message as an "error" event on the parent Scene.

Parameters
- message: string
  
  The message to log
Returns void

fire

fire(event: string, value: any, forget?: boolean): void

Inherited from Component.fire
- Defined in viewer/scene/Component.d.ts:72
Fires an event on this component.

Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.

Parameters
- event: string
  
  The event type name
- value: any
  
  The event parameters
- Optional forget: boolean
Returns void

flyToFrame

flyToFrame(frameIdx: number, ok?: () => void): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:74
Flies the Camera directly to the given frame on the CameraPathAnimation's CameraPath.

Parameters
- frameIdx: number
  
  Index of the frame to play to.
- Optional ok: () => void
  - - (): void
    - Returns void
Returns void

hasSubs

hasSubs(event: string): boolean

Inherited from Component.hasSubs
- Defined in viewer/scene/Component.d.ts:110
Returns true if there are any subscribers to the given event on this component.

Parameters
- event: string
  
  The event
Returns boolean
True if there are any subscribers to the given event on this component.

isType

isType(type: any): boolean

Inherited from Component.isType
- Defined in viewer/scene/Component.d.ts:60
Tests if this component is of the given type, or is a subclass of the given type.

Parameters
- type: any
Returns boolean

log

log(message: string): void

Inherited from Component.log
- Defined in viewer/scene/Component.d.ts:121
Logs a console debugging message for this component.

The console message will have this format: [LOG] [<component type> <component id>: <message>

Also fires the message as a "log" event on the parent Scene.

Parameters
- message: string
  
  The message to log
Returns void

off

off(subId: string): void

Inherited from Component.off
- Defined in viewer/scene/Component.d.ts:91
Cancels an event subscription that was previously made with Component.on or Component.once.

Parameters
- subId: string
  
  Subscription ID
Returns void

on

on(event: string, callback: Function, scope?: any): string

Inherited from Component.on
- Defined in viewer/scene/Component.d.ts:84
Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters
- event: string
  
  The event
- callback: Function
  
  Called fired on the event
- Optional scope: any
Returns string
Handle to the subscription, which may be used to unsubscribe with .off.

once

once(event: string, callback: Function, scope?: any): void

Inherited from Component.once
- Defined in viewer/scene/Component.d.ts:102
Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

This is equivalent to calling Component.on, and then calling Component.off inside the callback function.

Parameters
- event: string
  
  Data event to listen to
- callback: Function
  
  Called when fresh data is available at the event
- Optional scope: any
Returns void

play

play(): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:52
Begins animating the Camera along CameraPathAnimation's CameraPath from the beginning.

Returns void

playToFrame

playToFrame(frameIdx: number): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:66
Animates the Camera along CameraPathAnimation's CameraPath to the given frame.

Parameters
- frameIdx: number
  
  Index of the frame to play to.
Returns void

playToT

playToT(t: number): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:59
Begins animating the Camera along CameraPathAnimation's CameraPath from the given time.

Parameters
- t: number
  
  Time instant.
Returns void

scrubToFrame

scrubToFrame(frameIdx: number): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:88
Scrubs the Camera to the given frame on the CameraPathAnimation's CameraPath.

Parameters
- frameIdx: number
  
  Index of the frame to scrub to.
Returns void

scrubToT

scrubToT(t: number): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:81
Scrubs the Camera to the given time on the CameraPathAnimation's CameraPath.

Parameters
- t: number
  
  Time instant.
Returns void

stop

stop(): void

- Defined in viewer/scene/camera/CameraPathAnimation.d.ts:93
Stops playing this CameraPathAnimation.

Returns void

warn

warn(message: string): void

Inherited from Component.warn
- Defined in viewer/scene/Component.d.ts:132
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>

Also fires the message as a "warn" event on the parent Scene.

Parameters
- message: string
  
  The message to log
Returns void

Generated using TypeDoc