Engine API Reference - v2.21.0-beta.13
    Preparing search index...

    Class OrbitControllerAlpha

    The orbit controller.

    Hierarchy (View Summary)

    Index
    constructor
    _pose moveDamping rotateDamping zoomDamping
    pitchRange yawRange zoomRange
    attach destroy detach update

    Protected Alpha_pose

    _pose: Pose = ...
    moveDamping: number = 0.98

    The movement damping. In the range 0 to 1, where a value of 0 means no damping and 1 means full damping. Default is 0.98.

    rotateDamping: number = 0.98

    The rotation damping. In the range 0 to 1, where a value of 0 means no damping and 1 means full damping. Default is 0.98.

    zoomDamping: number = 0.98

    The zoom damping. A higher value means more damping. A value of 0 means no damping.

    • get pitchRange(): Vec2
      Alpha

      Returns Vec2

    • set pitchRange(range: Vec2): void
      Alpha

      Parameters

      Returns void

    • get yawRange(): Vec2
      Alpha

      Returns Vec2

    • set yawRange(range: Vec2): void
      Alpha

      Parameters

      Returns void

    • get zoomRange(): Vec2
      Alpha

      Returns Vec2

    • set zoomRange(range: Vec2): void
      Alpha

      Parameters

      Returns void

    • Alpha

      Parameters

      • pose: Pose

        The initial pose of the controller.

      • Optionalsmooth: boolean = true

        Whether to smooth the transition.

      Returns void

    • Alpha

      Returns void

    • Alpha

      Returns void

    • Alpha

      Parameters

      • frame: InputFrame<{ move: number[]; rotate: number[] }>

        The input frame.

      • dt: number

        The delta time.

      Returns Pose

      • The controller pose.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods