applyCameraPose

function

Back to Helios Web API

Kind

function

Source

src/rendering/CameraTransitionController.js:257

Description

Apply a captured or merged pose to a renderer camera.

Signature

export function applyCameraPose(camera, pose, { update = true } = {}) {

Parameters

Name	Type	Attributes	Default	Description
camera	Object			Renderer camera to update.
pose	Object			Pose fields to apply.
options	Object	optional		Application options.
|update	boolean	optional	true	Run the camera update hook after applying values.
update		optional	true } = {}	Value passed to export function applyCameraPose.

Returns

Updated camera, or null when no camera is supplied.

Type Object|null

Example

applyCameraPose(helios.renderer.camera, pose);