ReferenceScripting APICameraComponent
CameraComponent
classA 3D layer's camera, as a mote's component (its layer the 3D layer).
| Name | CameraComponent |
|---|---|
| Kind | class |
| Script reaches it as | import { CameraComponent } from "motion" |
| Since | 0.3 |
Syntax
class CameraComponent extends Component { … }Properties
| Name | Type | Description |
|---|---|---|
nameproperty | readonly string | Its name on its mote. |
layerproperty | readonly string | Its layer's id. |
visibleproperty | boolean | Whether its layer shows. |
opacityproperty | number | Its layer's opacity, 0 to 1. |
orbitproperty | readonly number | How far round it is, degrees. |
heightproperty | readonly number | How high it looks down from, degrees. |
distanceproperty | readonly number | How far it is from what it looks at, in the layer's units. |
fovproperty | readonly number | Its field of view, degrees. |
Methods
| Signature | Description |
|---|---|
new CameraComponent(name?: string, layer?: string): CameraComponentconstructor | Binds 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): voidmethod | Changes one of its layer's settings. |
animate(key: string, value: string | number, seconds: number, options?: MotionAnimateOptions): Promise<boolean>method | Moves one of its layer's settings. |
stopAnimating(key?: string): voidmethod | Stops its layer's moves. |
get(key: string): SettingValue | undefinedmethod | One of its layer's settings, as scene.get. |
read(key: string): SettingValue | undefinedmethod | One of its layer's settings as last drawn, as scene.read. |
show(visible?: boolean): voidmethod | Shows (or hides) its layer. |
hide(): voidmethod | Hides its layer. |
setOrbit(degrees: number, seconds?: number): Promise<boolean>method | Turns it round. |
setHeight(degrees: number, seconds?: number): Promise<boolean>method | Raises or lowers it. |
setDistance(distance: number, seconds?: number): Promise<boolean>method | Moves it nearer or further. |
setFov(degrees: number, seconds?: number): Promise<boolean>method | Widens or narrows its view. |
lookAt(target: [number, number, number] | { x: number; y: number; z: number }, seconds?: number): Promise<boolean>method | Turns it to face a point of its scene. |
See also
Notes from the community
Written by creators and checked by the docs' editors. Not part of Motion's official reference.