Class defaultAbstract

constructor

• new default(): default

  Returns default

ProtectedcameraComponent

ProtectedcameraTransform

attachSceneObject

• attachSceneObject(sceneObject: SceneObject): void

  Add SceneObject as a child of the camera's SceneObject

  Parameters

  • sceneObject: SceneObject

    SceneObject to attach

  Returns void

back

• back(): vec3

  Returns the back vector of the camera. This is actually the front vector because the camera is reversed in Lens Studio.

  Returns vec3

enableClearColor

• enableClearColor(color: vec4): void

  Clears the renderTarget with the provided color before drawing to it

  Parameters

  • color: vec4

    the color to clear the renderTarget with

  Returns void

forward

• forward(): vec3

  Returns the forward vector of the camera. This is actually the back vector because the camera is reversed in Lens Studio.

  Returns vec3

getClearColor

• getClearColor(): vec4

  Returns the clear color applied to the camera

  Returns vec4

getComponent

• getComponent(): Camera

  Returns the camera component

  Returns Camera

getForwardPosition

• getForwardPosition(x: number, parallelToGround?: boolean): vec3

  Parameters

  • x: number

    the magnitude to multiply the camera's forward direction by
  • parallelToGround: boolean = false

    if the camera's forward direction should be projected to be parallel to ground

  Returns vec3

  a position in world space in front of the camera by x units

getForwardPositionParallelToGround

• getForwardPositionParallelToGround(x: number): vec3

  Parameters

  • x: number

    the magnitude to multiply the camera's forward direction by

  Returns vec3

  a position in world space in front of the camera (parallel to ground)

getInvertedWorldTransform

• getInvertedWorldTransform(): mat4

  Returns mat4

  Inherit Doc

getLocalScale

• getLocalScale(): vec3

  Returns the camera's local scale

  Returns vec3

getTransform

• getTransform(): Transform

  Returns the camera's transform

  Returns Transform

getWorldPosition

• getWorldPosition(): vec3

  Returns the camera's world position

  Returns vec3

getWorldTransform

• getWorldTransform(): mat4

  Returns the camera's world transform

  Returns mat4

inFoV

• inFoV(worldPosition: vec3): boolean

  Parameters

  • worldPosition: vec3

    vec3 representing the position in world space

  Returns boolean

  whether a position is in camera FoV or not

renderLayer

• renderLayer(): LayerSet

  Returns the layer set to which this camera is rendering to

  Returns LayerSet

right

• right(): vec3

  Returns the right vector of the camera.

  Returns vec3

screenSpaceToWorldSpace

• screenSpaceToWorldSpace(x: number, y: number, absoluteDepth: number): vec3

  Returns the camera's world position projected from screen space coordinates at a given z depth

  Parameters

  • x: number
  • y: number
  • absoluteDepth: number

  Returns vec3

up

• up(): vec3

  Returns the up vector of the camera.

  Returns vec3

worldSpaceToScreenSpace

• worldSpaceToScreenSpace(x: number, y: number, z: number): vec2

  Parameters

  • x: number
  • y: number
  • z: number

  Returns vec2

  Inherit Doc