sceneview/io.github.sceneview.components/CameraComponent

CameraComponent

interface CameraComponent : Component

Inheritors

Properties

open val aperture: Float

Gets the aperture in f-stops

open val camera: FilamentCamera

open val cullingFar: Float

Gets the distance to the far plane

cullingProjectionTransform

open val cullingProjectionTransform: Mat4

Retrieves the camera's culling matrix. The culling matrix is the same as the projection matrix, except the far plane is finite.

abstract val engine: Engine

abstract val entity: Entity

open val far: Float

open val focalLength: Double

Gets the focal length in meters

open var focusDistance: Float

The distance from the camera to the focus plane in world units

forwardDirection

open val forwardDirection: Direction

Retrieves the camera forward unit vector in world space, that is a unit vector that points in the direction the camera is looking at.

open val leftDirection: Direction

Retrieves the camera left unit vector in world space, that is a unit vector that points to the left of the camera.

open var modelTransform: Transform

The camera's model matrix.

open val near: Float

Gets the distance to the near plane

projectionTransform

open var projectionTransform: Mat4

Retrieves the camera's projection matrix. The projection matrix used for rendering always has its far plane set to infinity. This is why it may differ from the matrix set through setProjection() or setLensProjection().

open val scaling: Float4

Returns the scaling amount used to scale the projection matrix.

open val sensitivity: Float

Gets the sensitivity in ISO

open val shutterSpeed: Float

Gets the shutter speed in seconds

open val upDirection: Direction

Retrieves the camera up unit vector in world space, that is a unit vector that points up with respect to the camera.

open val viewTransform: Transform

Retrieves the camera's view matrix. The view matrix is the inverse of the model matrix.

Functions

open fun lookAt(eye: Position, center: Position, up: Direction)

Sets the camera's model matrix.

setCustomProjection

open fun setCustomProjection(inProjection: Transform, near: Double = camera.near.toDouble(), far: Double = camera.cullingFar.toDouble(), inProjectionForCulling: Transform = inProjection)

Sets a custom projection matrix.

open fun setExposure(exposure: Float)

Sets this camera's exposure directly. Calling this method will set the aperture to 1.0, the shutter speed to 1.2 and the sensitivity will be computed to match the requested exposure (for a desired exposure of 1.0, the sensitivity will be set to 100 ISO).

open fun setExposure(aperture: Float, shutterSpeed: Float, sensitivity: Float)

Sets this camera's exposure (default is f/16, 1/125s, 100 ISO)

setLensProjection

open fun setLensProjection(focalLength: Double, aspect: Double, near: Double, far: Double)

Sets the projection matrix from the focal length.

open fun setProjection(fovInDegrees: Double, aspect: Double, near: Double, far: Double, direction: Camera.Fov)

Sets the projection matrix from the field-of-view.

open fun setProjection(projection: Camera.Projection, left: Double, right: Double, bottom: Double, top: Double, near: Double, far: Double)

Sets the projection matrix from a frustum defined by six planes.

open fun setScaling(scaling: Float2)

Sets an additional matrix that scales the projection matrix.

open fun setShift(xShift: Double, yShift: Double)

Sets an additional matrix that shifts (translates) the projection matrix.

open fun viewToRay(viewPosition: Float2): Ray

Calculates a ray in world space going from the near-plane of the camera and through a point in view space.

open fun viewToWorld(viewPosition: Float2, z: Float = 1.0f): Float3

Get a world space position from a view space position.

open fun worldToView(worldPosition: Position): Float2

Get a view space position from a world position.