Documentation / @ripl/3d / Camera
Class: Camera ​
Defined in: 3d/src/camera.ts:96
An interactive camera controlling the 3D context's view and projection, with mouse/touch orbit, pan, and zoom.
Extends ​
Constructors ​
Constructor ​
new Camera(
scene,options?):Camera
Defined in: 3d/src/camera.ts:175
Parameters ​
| Parameter | Type |
|---|---|
scene | Scene<any> |
options? | CameraOptions |
Returns ​
Camera
Overrides ​
Properties ​
| Property | Modifier | Type | Inherited from | Defined in |
|---|---|---|---|---|
defaultKey | readonly | typeof defaultKey | Disposer.defaultKey | core/src/core/disposer.ts:10 |
Accessors ​
far ​
Get Signature ​
get far():
number
Defined in: 3d/src/camera.ts:156
Returns ​
number
Set Signature ​
set far(
value):void
Defined in: 3d/src/camera.ts:160
Parameters ​
| Parameter | Type |
|---|---|
value | number |
Returns ​
void
fov ​
Get Signature ​
get fov():
number
Defined in: 3d/src/camera.ts:138
Returns ​
number
Set Signature ​
set fov(
value):void
Defined in: 3d/src/camera.ts:142
Parameters ​
| Parameter | Type |
|---|---|
value | number |
Returns ​
void
near ​
Get Signature ​
get near():
number
Defined in: 3d/src/camera.ts:147
Returns ​
number
Set Signature ​
set near(
value):void
Defined in: 3d/src/camera.ts:151
Parameters ​
| Parameter | Type |
|---|---|
value | number |
Returns ​
void
position ​
Get Signature ​
get position():
Vector3
Defined in: 3d/src/camera.ts:111
Returns ​
Set Signature ​
set position(
value):void
Defined in: 3d/src/camera.ts:115
Parameters ​
| Parameter | Type |
|---|---|
value | Vector3 |
Returns ​
void
projection ​
Get Signature ​
get projection():
"perspective"|"orthographic"
Defined in: 3d/src/camera.ts:165
Returns ​
"perspective" | "orthographic"
Set Signature ​
set projection(
value):void
Defined in: 3d/src/camera.ts:169
Parameters ​
| Parameter | Type |
|---|---|
value | "perspective" | "orthographic" |
Returns ​
void
target ​
Get Signature ​
get target():
Vector3
Defined in: 3d/src/camera.ts:120
Returns ​
Set Signature ​
set target(
value):void
Defined in: 3d/src/camera.ts:124
Parameters ​
| Parameter | Type |
|---|---|
value | Vector3 |
Returns ​
void
up ​
Get Signature ​
get up():
Vector3
Defined in: 3d/src/camera.ts:129
Returns ​
Set Signature ​
set up(
value):void
Defined in: 3d/src/camera.ts:133
Parameters ​
| Parameter | Type |
|---|---|
value | Vector3 |
Returns ​
void
Methods ​
dispose() ​
dispose():
void
Defined in: 3d/src/camera.ts:458
Disposes all resources under the given key, or all resources if no key is provided.
Returns ​
void
Overrides ​
flush() ​
flush():
void
Defined in: 3d/src/camera.ts:206
Flushes pending camera changes to the 3D context's view and projection matrices.
Returns ​
void
lookAt() ​
lookAt(
target):void
Defined in: 3d/src/camera.ts:279
Parameters ​
| Parameter | Type |
|---|---|
target | Vector3 |
Returns ​
void
orbit() ​
orbit(
deltaTheta,deltaPhi):void
Defined in: 3d/src/camera.ts:233
Parameters ​
| Parameter | Type |
|---|---|
deltaTheta | number |
deltaPhi | number |
Returns ​
void
pan() ​
pan(
dx,dy):void
Defined in: 3d/src/camera.ts:253
Parameters ​
| Parameter | Type |
|---|---|
dx | number |
dy | number |
Returns ​
void
retain() ​
protectedretain(value,key?):void
Defined in: core/src/core/disposer.ts:13
Registers a disposable resource under an optional key for later cleanup.
Parameters ​
| Parameter | Type | Default value |
|---|---|---|
value | Disposable | undefined |
key | PropertyKey | Disposer.defaultKey |
Returns ​
void
Inherited from ​
zoom() ​
zoom(
delta):void
Defined in: 3d/src/camera.ts:269
Parameters ​
| Parameter | Type |
|---|---|
delta | number |
Returns ​
void