Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CameraController

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

Hierarchy

  • CameraController

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly propertyChanged

propertyChanged: EventHandler<PropertyChangedEventArgs>

An event handler which notifies subscribers that a property has changed and scene must be updated

Accessors

aspectRatio

  • get aspectRatio(): number
  • set aspectRatio(value: number): void

  • Gets or sets the camera aspect ratio. Defaults to 1.333333333

    inheritdoc

    Returns number

  • Gets or sets the camera aspect ratio. Defaults to 1.333333333

    inheritdoc

    Parameters

    • value: number

    Returns void

farClip

  • get farClip(): number
  • set farClip(value: number): void

  • 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

    inheritdoc

    Returns 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

    inheritdoc

    Parameters

    • value: number

    Returns void

fieldOfView

  • get fieldOfView(): number
  • set fieldOfView(value: number): void

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

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

forward

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

    inheritdoc

    Returns Vector3

id

  • get id(): string
  • set id(value: string): void

  • Gets or sets the unique camera Id

    inheritdoc

    Returns string

  • Gets or sets the unique camera Id

    inheritdoc

    Parameters

    • value: string

    Returns void

isAttached

  • get isAttached(): boolean
  • set isAttached(value: boolean): void

  • Gets whether the camera is attached to a SciChart3DSurface or not

    inheritdoc

    Returns boolean

  • Gets whether the camera is attached to a SciChart3DSurface or not

    inheritdoc

    Parameters

    • value: boolean

    Returns void

nearClip

  • get nearClip(): number
  • set nearClip(value: number): void

  • 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

    inheritdoc

    Returns 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

    inheritdoc

    Parameters

    • value: number

    Returns void

orbitalPitch

  • get orbitalPitch(): number
  • set orbitalPitch(value: number): void

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

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

orbitalYaw

  • get orbitalYaw(): number
  • set orbitalYaw(value: number): void

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

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

orthoHeight

  • get orthoHeight(): number
  • set orthoHeight(value: number): void

  • Gets or sets the orthogonal viewable height in world coordinates

    inheritdoc

    Returns number

  • Gets or sets the orthogonal viewable height in world coordinates

    inheritdoc

    Parameters

    • value: number

    Returns void

orthoWidth

  • get orthoWidth(): number
  • set orthoWidth(value: number): void

  • Gets or sets the orthogonal viewable width in world coordinates

    inheritdoc

    Returns number

  • Gets or sets the orthogonal viewable width in world coordinates

    inheritdoc

    Parameters

    • value: number

    Returns void

position

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

    inheritdoc

    Returns Vector3

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

    inheritdoc

    Parameters

    Returns void

projectionMode

radius

  • get radius(): number
  • set radius(value: number): void

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

    inheritdoc

    Returns number

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

    inheritdoc

    Parameters

    • value: number

    Returns void

side

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

    inheritdoc

    Returns Vector3

target

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

    inheritdoc

    Returns Vector3

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

    inheritdoc

    Parameters

    Returns void

up

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

    inheritdoc

    Returns Vector3

upGlobal

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

    inheritdoc

    Returns Vector3

Methods

debugOutput

  • debugOutput(): string[]

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

    Returns string[]

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

  • Notifies subscribers of propertyChanged that a property has changed and the scene needs updating

    Parameters

    • propertyName: string

    Returns void

resetToDefaults

  • resetToDefaults(): 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