Options
Menu

Class FollowController

Controller used to follow behind an object on the XZ plane, with an optional elevation (tiltAngle).

see

away3d.containers.View3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_iCurrentPanAngle

_iCurrentPanAngle: number

_iCurrentTiltAngle

_iCurrentTiltAngle: number

_pAutoUpdate

_pAutoUpdate: boolean

_pControllerDirty

_pControllerDirty: boolean

_pLookAtObject

_pLookAtObject: DisplayObject

_pLookAtPosition

_pLookAtPosition: Vector3D

_pOrigin

_pOrigin: Vector3D

_pTargetObject

_pTargetObject: DisplayObject

Accessors

autoUpdate

  • get (): boolean
  • set (val: boolean): void

distance

  • get (): number
  • set (val: number): void

  • Distance between the camera and the specified target. Defaults to 1000.

    Returns number

  • Distance between the camera and the specified target. Defaults to 1000.

    Parameters

    • val: number

    Returns void

lookAtObject

lookAtPosition

  • get (): Vector3D
  • set (val: Vector3D): void

maxPanAngle

  • get (): number
  • set (val: number): void

  • Maximum bounds for the panAngle. Defaults to Infinity.

    see

    #panAngle

    Returns number

  • Maximum bounds for the panAngle. Defaults to Infinity.

    Parameters

    • val: number

    Returns void

maxTiltAngle

  • get (): number
  • set (val: number): void

  • Maximum bounds for the tiltAngle. Defaults to 90.

    see

    #tiltAngle

    Returns number

  • Maximum bounds for the tiltAngle. Defaults to 90.

    Parameters

    • val: number

    Returns void

minPanAngle

  • get (): number
  • set (val: number): void

  • Minimum bounds for the panAngle. Defaults to -Infinity.

    see

    #panAngle

    Returns number

  • Minimum bounds for the panAngle. Defaults to -Infinity.

    Parameters

    • val: number

    Returns void

minTiltAngle

  • get (): number
  • set (val: number): void

  • Minimum bounds for the tiltAngle. Defaults to -90.

    see

    #tiltAngle

    Returns number

  • Minimum bounds for the tiltAngle. Defaults to -90.

    Parameters

    • val: number

    Returns void

panAngle

  • get (): number
  • set (val: number): void

  • Rotation of the camera in degrees around the y axis. Defaults to 0.

    Returns number

  • Rotation of the camera in degrees around the y axis. Defaults to 0.

    Parameters

    • val: number

    Returns void

steps

  • get (): number
  • set (val: number): void

  • Fractional step taken each time the hover() method is called. Defaults to 8.

    Affects the speed at which the tiltAngle and panAngle resolve to their targets.

    see

    #tiltAngle

    see

    #panAngle

    Returns number

  • Fractional step taken each time the hover() method is called. Defaults to 8.

    Affects the speed at which the tiltAngle and panAngle resolve to their targets.

    Parameters

    • val: number

    Returns void

targetObject

tiltAngle

  • get (): number
  • set (val: number): void

  • Elevation angle of the camera in degrees. Defaults to 90.

    Returns number

  • Elevation angle of the camera in degrees. Defaults to 90.

    Parameters

    • val: number

    Returns void

wrapPanAngle

  • get (): boolean
  • set (val: boolean): void

  • Defines whether the value of the pan angle wraps when over 360 degrees or under 0 degrees. Defaults to false.

    Returns boolean

  • Defines whether the value of the pan angle wraps when over 360 degrees or under 0 degrees. Defaults to false.

    Parameters

    • val: boolean

    Returns void

yFactor

  • get (): number
  • set (val: number): void

  • Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2.

    see

    #distance

    Returns number

  • Fractional difference in distance between the horizontal camera orientation and vertical camera orientation. Defaults to 2.

    Parameters

    • val: number

    Returns void

Methods

pNotifyUpdate

  • pNotifyUpdate(): void

update

  • update(interpolate?: boolean): void

  • Parameters

    • Default value interpolate: boolean = true

    Returns void

updateController

  • updateController(): void

Generated using TypeDoc