Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Camera

Concrete 3D Camera, setting out 3D-specific properties and behavior, providing type safety for Aura3D

Supports both Orthographic and Perspecitve Projection approaches by way of the projection configuration member 'mode'

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Constructor. Pass a 2D CameraConfig to the parent class and initialize the projection and view matrices

    Parameters

    Returns Camera

Properties

Protected Readonly config

config: CameraConfig

Protected following

following: undefined | CameraFollow

Concrete 3D CameraFollow specification

projection

projection: Mat4

Concrete 3D projection matrix

Protected transform

transform: Transform

Concrete 3D Transform Component, used as the View Matrix

Accessors

name

  • get name(): string

  • Retrieve the Camera's name

    Returns string

Methods

attachTo

  • Attach the 3D Camera to an Entity with the given 3D CameraFollowRules

    If no CameraFollowRules are provided, use defaults: - position.x - true - position.y - true - position.z - true - angles.x (pitch) - true - angles.y (yaw) - true - angles.z (roll) - false

    Parameters

    • entity: Entity

      the Entity to follow

    • Optional rules: CameraFollowRules

      the 3D CameraFollowRules to apply in following the Entity

    Returns void

detach

  • detach(): void

  • Detach the Camera from the Entity it's following

    Returns void

getViewMatrix

  • getViewMatrix(): Mat4

  • Compute the 3D Camera's View Matrix

    Returns Mat4

    the 3D View Matrix

move

  • move(amounts: Vec3): void

  • Move along all three axes by a given 3D vector (relative to self)

    Parameters

    • amounts: Vec3

      the 3D vector to move by

    Returns void

moveForward

  • moveForward(amount: number): void

  • Move along the forward axis by a given amount (relative to self)

    Parameters

    • amount: number

      the amount to move by

    Returns void

moveRight

  • moveRight(amount: number): void

  • Move along the right axis by a given amount (relative to self)

    Parameters

    • amount: number

      the amount to move by

    Returns void

moveUp

  • moveUp(amount: number): void

  • Move along the up axis by a given amount (relative to self)

    Parameters

    • amount: number

      the amount to move by

    Returns void

reset

  • reset(): void

  • Reset the Camera's Transform

    Returns void

rotate

  • rotate(angles: Vec3): void

  • Rotate around all three axes by 3 given angles (radians)

    Parameters

    • angles: Vec3

      the X, Y and Z angles to rotate by

    Returns void

rotateX

  • rotateX(angle: number): void

  • Rotate by a given angle (radians) around the X axis; pitch

    Parameters

    • angle: number

      the angle to rotate by

    Returns void

rotateY

  • rotateY(angle: number): void

  • Rotate by a given angle (radians) around the Y axis; yaw

    Parameters

    • angle: number

      the angle to rotate by

    Returns void

rotateZ

  • rotateZ(angle: number): void

  • Rotate by a given angle (radians) around the Z axis; roll

    Parameters

    • angle: number

      the angle to rotate by

    Returns void

translate

  • translate(translate: Vec3): void

  • Move by a given translation vector (relative to world axes)

    Parameters

    • translate: Vec3

      the translation vector

    Returns void

zoom

  • zoom(factor: Vec3): void

  • 'Zoom' the Camera by scaling by a given factor (relative to current scale)

    Parameters

    • factor: Vec3

      the 3D factor to scale by

    Returns void

zoomTo

  • zoomTo(factor: Vec3): void

  • 'Zoom' the Camera by scaling to a given absolute factor

    Parameters

    • factor: Vec3

      the 3D factor to scale to

    Returns void