Motion
Get Motion

ReferenceScripting APICameraComponent

CameraComponent

class

A 3D layer's camera, as a mote's component (its layer the 3D layer).

NameCameraComponent
Kindclass
Script reaches it asimport { CameraComponent } from "motion"
Since0.3

Syntax

class CameraComponent extends Component { … }

Properties

NameTypeDescription
namepropertyreadonly stringIts name on its mote.
layerpropertyreadonly stringIts layer's id.
visiblepropertybooleanWhether its layer shows.
opacitypropertynumberIts layer's opacity, 0 to 1.
orbitpropertyreadonly numberHow far round it is, degrees.
heightpropertyreadonly numberHow high it looks down from, degrees.
distancepropertyreadonly numberHow far it is from what it looks at, in the layer's units.
fovpropertyreadonly numberIts field of view, degrees.

Methods

SignatureDescription
new CameraComponent(name?: string, layer?: string): CameraComponentconstructorBinds a layer to a mote by hand. A mote's components are made with it, from the layers it's given in Studio, so you rarely need this.
set(key: string, value: SettingValue): voidmethodChanges one of its layer's settings.
animate(key: string, value: string | number, seconds: number, options?: MotionAnimateOptions): Promise<boolean>methodMoves one of its layer's settings.
stopAnimating(key?: string): voidmethodStops its layer's moves.
get(key: string): SettingValue | undefinedmethodOne of its layer's settings, as scene.get.
read(key: string): SettingValue | undefinedmethodOne of its layer's settings as last drawn, as scene.read.
show(visible?: boolean): voidmethodShows (or hides) its layer.
hide(): voidmethodHides its layer.
setOrbit(degrees: number, seconds?: number): Promise<boolean>methodTurns it round.
setHeight(degrees: number, seconds?: number): Promise<boolean>methodRaises or lowers it.
setDistance(distance: number, seconds?: number): Promise<boolean>methodMoves it nearer or further.
setFov(degrees: number, seconds?: number): Promise<boolean>methodWidens or narrows its view.
lookAt(target: [number, number, number] | { x: number; y: number; z: number }, seconds?: number): Promise<boolean>methodTurns it to face a point of its scene.

See also

SettingValue