Camera | CoSpaces API

Client camera and CameraItem controls.

The client camera uses ReadonlyTransform. Its position and orientation can not be modified. To manipulate the client camera rotation and position programmatically, use CameraItem.

Index

Type Aliases

MovementType

Variables

Functions

Type Aliases

MovementType

MovementType: "fly" | "walk" | "fixed_position" | "fixed" | "orbit"

Defines the movement behavior of a CameraItem.

fly - Camera can fly
walk - Camera can be walk over the ground and items
fixed_position - Movement is disabled. Camera can only rotate
fixed - Movement and rotation is disabled
orbit - Camera rotates around a fixed point

Variables

collisionCapsuleHeight

collisionCapsuleHeight: number

Defines the Camera collision height.

collisionCapsuleRadius

collisionCapsuleRadius: number

Defines the Camera collision radius.

focusedItem

focusedItem: CameraItem

Defines the CameraItem that the client is currently looking through.

If no CameraItem is focused, this returns null.

gravity

gravity: number

Defines the Camera falling speed when walk MovementType is used.

jumpVelocity

jumpVelocity: number

Defines the jump velocity of the Camera when walk MovementType is used.

Camera jumping is not supported in AR and VR ViewMode.

mouseLocked

mouseLocked: boolean

Locks the mouse pointer and binds camera-turning to mouse movement.

To exit locked mouse pointer state, press ESC key.

Only available on platforms that support mouse input.

physicsCollision

physicsCollision: boolean

Toggles Camera collision with physics-enabled items.

slopeAngle

slopeAngle: number

Defines the maximum slope angle which the Camera can climb up and down.

stayAngle

stayAngle: number

Defines the maximum angle at which the Camera can stay on a slope without sliding down.

Const transform

transform: ReadonlyTransform

Readonly Transform of the client Camera.

To move the Camera by script, use the editable Transform of CameraItem.

Functions

addToCollisionFilter

addToCollisionFilter(item: BaseItem): void

- Defined in api.ts:1342
Adds a BaseItem to the Camera collision filter, disabling collisions against it.

Parameters
- item: BaseItem
Returns void

bindMovementKeys

bindMovementKeys(keyBindings: { flyDown?: KeyCode | KeyCode[]; flyUp?: KeyCode | KeyCode[]; jump?: KeyCode | KeyCode[]; lookDown?: KeyCode | KeyCode[]; lookLeft?: KeyCode | KeyCode[]; lookRight?: KeyCode | KeyCode[]; lookUp?: KeyCode | KeyCode[]; moveBackward?: KeyCode | KeyCode[]; moveForward?: KeyCode | KeyCode[]; moveLeft?: KeyCode | KeyCode[]; moveRight?: KeyCode | KeyCode[] }): void

- Defined in api.ts:1380
Replaces default CameraItem movement and binds it to the specified set of KeyCode buttons.
Note
- Movement on mobile and VR devices is not overwritten
- orbit mode is not affected by look... parameters
- fixed_position mode is not affected by move... parameters
- jump is only bound to walk mode with enabled camera collision
- flyUp and flyDown is only bound to fly mode
Parameters
- keyBindings: { flyDown?: KeyCode | KeyCode[]; flyUp?: KeyCode | KeyCode[]; jump?: KeyCode | KeyCode[]; lookDown?: KeyCode | KeyCode[]; lookLeft?: KeyCode | KeyCode[]; lookRight?: KeyCode | KeyCode[]; lookUp?: KeyCode | KeyCode[]; moveBackward?: KeyCode | KeyCode[]; moveForward?: KeyCode | KeyCode[]; moveLeft?: KeyCode | KeyCode[]; moveRight?: KeyCode | KeyCode[] }
  - Optional Readonly flyDown?: KeyCode | KeyCode[]
  - Optional Readonly flyUp?: KeyCode | KeyCode[]
  - Optional Readonly jump?: KeyCode | KeyCode[]
  - Optional Readonly lookDown?: KeyCode | KeyCode[]
  - Optional Readonly lookLeft?: KeyCode | KeyCode[]
  - Optional Readonly lookRight?: KeyCode | KeyCode[]
  - Optional Readonly lookUp?: KeyCode | KeyCode[]
  - Optional Readonly moveBackward?: KeyCode | KeyCode[]
  - Optional Readonly moveForward?: KeyCode | KeyCode[]
  - Optional Readonly moveLeft?: KeyCode | KeyCode[]
  - Optional Readonly moveRight?: KeyCode | KeyCode[]
Returns void

removeFromCollisionFilter

removeFromCollisionFilter(item: BaseItem): void

- Defined in api.ts:1347
Removes a BaseItem from the Camera collision filter, enabling collision against it.

Parameters
- item: BaseItem
Returns void

screenToWorld

screenToWorld(screenPosition: Vector2, distance: number): Vector3

- Defined in api.ts:1422
Converts a position from screen space (e.g. of the mouse) to world space.

Parameters
- screenPosition: Vector2
  
  position in the Camera viewport.
- distance: number
  
  local y-axis distance to the Camera.
Returns Vector3
converted position in the Scene.

worldToScreen

worldToScreen(worldPosition: Vector3): Vector2

- Defined in api.ts:1431
Converts a position from world space to screen space.

Parameters
- worldPosition: Vector3
  
  position in the Scene.
Returns Vector2
converted position in the Camera viewport.

Index

Type Aliases

Variables

Functions

Type Aliases

MovementType

Variables

collisionCapsuleHeight

collisionCapsuleRadius

focusedItem

gravity

jumpVelocity

mouseLocked

physicsCollision

slopeAngle

stayAngle

Const transform

Functions

addToCollisionFilter

Parameters

item: BaseItem

Returns void

bindMovementKeys

Parameters

Optional Readonly flyDown?: KeyCode | KeyCode[]

Optional Readonly flyUp?: KeyCode | KeyCode[]

Optional Readonly jump?: KeyCode | KeyCode[]

Optional Readonly lookDown?: KeyCode | KeyCode[]

Optional Readonly lookLeft?: KeyCode | KeyCode[]

Optional Readonly lookRight?: KeyCode | KeyCode[]

Optional Readonly lookUp?: KeyCode | KeyCode[]

Optional Readonly moveBackward?: KeyCode | KeyCode[]

Optional Readonly moveForward?: KeyCode | KeyCode[]

Optional Readonly moveLeft?: KeyCode | KeyCode[]

Optional Readonly moveRight?: KeyCode | KeyCode[]

Returns void

removeFromCollisionFilter

Parameters

item: BaseItem

Returns void

screenToWorld

Parameters

screenPosition: Vector2

distance: number

Returns Vector3

worldToScreen

Parameters

worldPosition: Vector3

Returns Vector2