Skip to content

CameraTransitionController

class

Back to Helios Web API

Kind
class
Source
src/rendering/CameraTransitionController.js:346

Description

Time-based camera transition controller used by Helios camera animations.

Signature

export class CameraTransitionController {

Parameters

NameTypeAttributesDefaultDescription
optionsObjectController dependencies.
cameraObjectRenderer camera to animate.
requestRenderFunctionoptionalCallback used to schedule a render.
nowFunctionoptionalClock function returning milliseconds.
requestRenderoptionalnull } = {}Value passed to constructor.

Utilities

Additional public helpers that do not belong to a narrower API area.

stop()

Source: src/rendering/CameraTransitionController.js:353

Configures or reads stop.

transition(camera, { fromPose, toPose, durationMs = 320 } = {})

Source: src/rendering/CameraTransitionController.js:365

Configures or reads transition.

Parameters

NameTypeAttributesDefaultDescription
cameraValue passed to transition.
fromPoseCamera pose fields to apply.
toPoseCamera pose fields to apply.
durationMsoptional320 } = {}Value passed to transition.