@masatomakino/threejs-spherical-controls
    Preparing search index...

    Class SphericalController

    球面座標系でカメラ位置をコントロールするクラス。

    カメラ位置はThetaおよびPhiで決定される。 0, 0の場合北極上にカメラが位置する。 Phi : 0 ~ Math.PI (縦回転) Theta : -Math.PI ~ Math.PI (横回転) の範囲で可動する。

    北極南極を通過すると緯度も反転するため、このクラスでは南北90度以上の移動には対応していない。また、極点上空では座標が一意の値にならないため、Phi 0もしくはPIには対応していない。

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    limiter tweens prefixed

    Methods

    addListener addPosition addTargetPosition changeTarget cloneSphericalPosition copySphericalPosition dispatchUpdateEvent dispose emit eventNames initCameraPosition initCameraShift listenerCount listeners loop move moveCameraShift movePosition moveTarget off on once removeAllListeners removeListener stopLoop

    Constructors

    Properties

    limiter: CameraPositionLimiter = ...
    tweens: SphericalControllerTween = ...
    prefixed: string | boolean

    Methods

    • Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T
      • fn:
            | (
                (
                    ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
                ) => void
            )
            | (
                (
                    ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                        T,
                        keyof SphericalControllerEventMap,
                    >],
                ) => void
            )
      • Optionalcontext: any

      Returns this

    • カメラのSpherical座標に加算する。

      Parameters

      • type: SphericalParamType
      • value: number
      • overrideTween: boolean = false

        現在実行中のアニメーションを中断し、座標を上書きするか否か。

      • addDuringTween: boolean = false

        アニメーション中の座標加算を許可するか。許可する場合、typeで指定した値がアニメーションしていなければ加算される。

      Returns void

    • カメラターゲットの座標を加算する。 水平、垂直移動などに使用

      Parameters

      • pos: Vector3
      • overrideTween: boolean = false

      Returns void

    • カメラターゲットの変更 TODO 現状未実装。カメラターゲットが変更になった際の移動方法を調査、実装。

      Parameters

      • _target: Mesh

      Returns void

    • カメラ座標を他のSphericalオブジェクトに転写する。

      Parameters

      • spherical: Spherical

      Returns Spherical

    • Calls each of the listeners registered for a given event.

      Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      Returns boolean

    • Return an array listing the events for which the emitter has registered listeners.

      Returns ("update" | (keyof SphericalControllerEventMap))[]

    • カメラ位置の初期設定を行う

      Parameters

      • pos: Spherical
      • OptionaltargetPos: Vector3

      Returns void

    • カメラの位置ずれ設定を行う。

      Parameters

      • shift: Vector3

      Returns void

    • Return the number of listeners listening to a given event.

      Parameters

      • event: "update" | (keyof SphericalControllerEventMap)

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T

      Returns (
          | (
              (
                  ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
              ) => void
          )
          | (
              (
                  ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                      T,
                      keyof SphericalControllerEventMap,
                  >],
              ) => void
          )
      )[]

    • カメラ位置をループで移動させる。 ゆらゆらと動かすための処理。

      Parameters

      • type: SphericalParamType

        どのプロパティを操作するか。

      • min: number
      • max: number
      • Optionaloption: EasingOption

        このアニメーションに対する1回限りの設定を行う。

      Returns void

    • Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T
      • Optionalfn:
            | (
                (
                    ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
                ) => void
            )
            | (
                (
                    ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                        T,
                        keyof SphericalControllerEventMap,
                    >],
                ) => void
            )
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    • Add a listener for a given event.

      Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T
      • fn:
            | (
                (
                    ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
                ) => void
            )
            | (
                (
                    ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                        T,
                        keyof SphericalControllerEventMap,
                    >],
                ) => void
            )
      • Optionalcontext: any

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T
      • fn:
            | (
                (
                    ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
                ) => void
            )
            | (
                (
                    ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                        T,
                        keyof SphericalControllerEventMap,
                    >],
                ) => void
            )
      • Optionalcontext: any

      Returns this

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: "update" | (keyof SphericalControllerEventMap)

      Returns this

    • Remove the listeners of a given event.

      Type Parameters

      • T extends "update" | (keyof SphericalControllerEventMap)

      Parameters

      • event: T
      • Optionalfn:
            | (
                (
                    ...args: ArgumentMap<CameraUpdateEventMap>[Extract<T, "update">],
                ) => void
            )
            | (
                (
                    ...args: ArgumentMap<SphericalControllerEventMap>[Extract<
                        T,
                        keyof SphericalControllerEventMap,
                    >],
                ) => void
            )
      • Optionalcontext: any
      • Optionalonce: boolean

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods