Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICameraController

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Defines the interface to a CameraController - a Class which manipulates and manages the camera in 3D space within SciChart's High Performance JavaScript 3D Charts

Hierarchy

  • ICameraController

Implemented by

Index

Properties

Methods

Properties

aspectRatio

aspectRatio: number

Gets or sets the camera aspect ratio. Defaults to 1.333333333

farClip

farClip: number

Gets or sets the far clipping in world coordinates, for example if set to 1,000 any object further than 1,000 world coordinates will not be rendered

fieldOfView

fieldOfView: number

Gets the field of view in degrees. Default value is 60

Readonly forward

forward: Vector3

Gets the Forward Vector3; the vector which results from target - position

id

id: string

Gets or sets the unique camera Id

isAttached

isAttached: boolean

Gets whether the camera is attached to a SciChart3DSurface or not

nearClip

nearClip: number

Gets or sets the near clipping in world coordinates, for example if set to 1.0, any object closer than 1 world coordinate will not be rendered

orbitalPitch

orbitalPitch: number

Gets or sets the Orbital Pitch - a vertical rotation angle around the target - in degrees

remarks

This property will be updated when you set CameraController.position or CameraController.target. Similarly, setting CameraController.orbitalPitch will result in position & target being updated.

orbitalYaw

orbitalYaw: number

Gets or sets the Orbital Yaw - a horizontal rotation angle around the target - in degrees

remarks

This property will be updated when you set CameraController.position or CameraController.target. Similarly, setting CameraController.orbitalYaw will result in position & target being updated.

orthoHeight

orthoHeight: number

Gets or sets the orthogonal viewable height in world coordinates

remarks

Applicable when CameraController.projectionMode is Orthogonal

orthoWidth

orthoWidth: number

Gets or sets the orthogonal viewable width in world coordinates

remarks

Applicable when CameraController.projectionMode is Orthogonal

position

position: Vector3

Gets or sets the camera position as a Vector3 in World Space

projectionMode

projectionMode: ECameraProjectionMode

Gets or sets the ECameraProjectionMode. Default is ECameraProjectionMode.Perspective and using this property you can also set the camera mode to Orthogonal

propertyChanged

propertyChanged: EventHandler<PropertyChangedEventArgs>

An event handler which raises events when a property changes and the scene must be redrawn

radius

radius: number

Gets or sets the radius - the distance from the CameraController.target

remarks

This property will be updated when you set CameraController.position or CameraController.target. Similarly, setting CameraController.radius will result in position & target being updated.

Readonly side

side: Vector3

Gets the Side Vector3; the vector which is orthogonal to up and forward

target

target: Vector3

Gets or sets the camera target (Look-at) as a Vector3 in World Space

Readonly up

up: Vector3

Gets the Up Vector3; the vector pointing straight up from the camera's position

Readonly upGlobal

upGlobal: Vector3

Gets the global up Vector3; a vector which defaults to Xyz = [0,1,0]

Methods

debugOutput

  • debugOutput(): void

  • Used internally - call to dump camera properties to the console log

    Returns void

resetToDefaults

  • resetToDefaults(): void

  • Resets the camera properties to defaults

    Returns void

toOrthogonal

  • toOrthogonal(): void

  • Does the hard maths for you to convert the current Perspective camera to an Orthogonal camera with the same position and target

    Returns void

toPerspective

  • toPerspective(): void

  • Does the hard maths for you to convert the current Orthogonal camera to an Perspective camera with the same position and target

    Returns void

updateEngineCamera

  • updateEngineCamera(tsrCamera: TSRCamera): void

  • Used internally - Updates a {@link TSRCamera} instance which will be passed to SciChart's fast WebGL WebAssembly engine

    Parameters

    • tsrCamera: TSRCamera

    Returns void

Generated using TypeDoc