Options
Menu

Class FirstPersonController

Extended camera used to hover round a specified target object.

see

away3d.containers.View3D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new FirstPersonController(targetObject?: DisplayObject, panAngle?: number, tiltAngle?: number, minTiltAngle?: number, maxTiltAngle?: number, steps?: number, wrapPanAngle?: boolean): FirstPersonController

  • Creates a new HoverController object.

    Parameters

    • Default value targetObject: DisplayObject = null
    • Default value panAngle: number = 0
    • Default value tiltAngle: number = 90
    • Default value minTiltAngle: number = -90
    • Default value maxTiltAngle: number = 90
    • Default value steps: number = 8
    • Default value wrapPanAngle: boolean = false

    Returns FirstPersonController

Properties

_iCurrentPanAngle

_iCurrentPanAngle: number

_iCurrentTiltAngle

_iCurrentTiltAngle: number

_pAutoUpdate

_pAutoUpdate: boolean

_pControllerDirty

_pControllerDirty: boolean

_pTargetObject

_pTargetObject: DisplayObject

fly

fly: boolean

Accessors

autoUpdate

  • get (): boolean
  • set (val: boolean): 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

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

Methods

incrementStrafe

  • incrementStrafe(val: number): void

  • Parameters

    • val: number

    Returns void

incrementWalk

  • incrementWalk(val: number): void

  • Parameters

    • val: number

    Returns void

pNotifyUpdate

  • pNotifyUpdate(): void

update

  • update(interpolate?: boolean): void

  • Updates the current tilt angle and pan angle values.

    Values are calculated using the defined tiltAngle, panAngle and steps variables.

    see

    #tiltAngle

    see

    #panAngle

    see

    #steps

    Parameters

    • Default value interpolate: boolean = true

      If the update to a target pan- or tiltAngle is interpolated. Default is true.

    Returns void

updateController

  • updateController(): void

Generated using TypeDoc