API Docs for: 2.0.0
Show:

CameraFlyAnimation Class

Extends Component
Module: animation
Parent Module: BIMSURFER

Fly flys a Camera

Overview

Example

TODO

 TODO

Constructor

CameraFlyAnimation

(
  • [viewer]
  • [cfg]
)

Parameters:

  • [viewer] Viewer optional

    Parent Viewer.

  • [cfg] optional

    Fly configuration

    • [id] String optional

      Optional ID, unique among all components in the parent Viewer, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this CameraFlyAnimation.

    • [camera] Camera optional

      Camera to control

Methods

destroy

()

Destroys this component.

Removes this Component from its Viewer.

Fires a destroyed event on this Component.

error

(
  • message
)

Logs an error for this component to the JavaScript console.

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

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

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

Parameters:

  • event String

    The event type name

  • value Object

    The event

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

flyTo

(
  • params
  • [ok]
)

Begins flying this CameraFlyAnimation's Camera to the given target.

  • When the target is a boundary, the Camera will fly towards the target and stop when the target fills most of the canvas.
  • When the target is an explicit Camera position, given as eye, look and up vectors, then this CameraFlyAnimation will interpolate the Camera to that target and stop there.

Parameters:

  • params

    Flight parameters

    • [arc=0] Factor in range [0..1] Number optional

      indicating how much the Camera's eye position will swing away from its look position as it flies to the target.

    • [boundary] Xmin:Number, ymin:Number, zmin: Number, xmax: Number, ymax: Number, zmax: Number optional

      } Boundary target to fly to.

    • [eye] Array of Number optional

      Position to fly the Camera's eye position to.

    • [look] Array of Number optional

      Position to fly the Camera's look position to.

    • [up] Array of Number optional

      Position to fly the Camera's up vector to.

  • [ok] Function optional

    Callback fired on arrival

log

(
  • message
)

Logs a console debugging message for this component.

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

Parameters:

  • message String

    The message to log

off

(
  • handle
)

Cancels an event subscription that was previously made with on or once.

Parameters:

  • handle String

    Subscription handle

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    Publication event

  • callback Function

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

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

Parameters:

  • message String

    The message to log

Properties

className

String final

JavaScript class name for this Component.

destroyed

Boolean

True as soon as this Component has been destroyed

id

String final

Unique ID for this Component within its parent Viewer.

Items in this map

Unknown

metadata

Object

Metadata on this component.

viewer

Viewer final

The Viewer that contains this Component.

Events

destroyed

Fired when this Component is destroyed.