如视 Five SDK
    Preparing search index...

    Interface TrajectoryController

    plugin 的基本控制器

    interface TrajectoryController {
        currentKeyFrame: Keyframe;
        data?: any;
        five: Five;
        hooks: Subscribe<PluginTemplateType.EventMap>;
        keyframes: Keyframe[];
        location: number;
        nextButOneKeyframe: Keyframe;
        nextKeyframe: Keyframe;
        playbackEndTime: number;
        playbackStartTime: number;
        rate: number;
        skipEnd: number;
        skipStart: number;
        startTimestamp: number;
        state: PluginTemplateType.State;
        staticPrefix: string;
        totalDistance: number;
        trajectory: Trajectory;
        get config(): { rate?: number };
        absoluteUrl(url: string): string;
        appendTo?(wrapper: Element): void;
        disable(options?: BaseOptions): void;
        dispose(): void;
        enable(options?: BaseOptions): void;
        findKeyFrameByLocation(
            location: number,
        ): number | { keyframeIndex: number; progress: number };
        findKeyFrameByTimestamp(timestamp: number): number;
        getCurrentState(): PluginTemplateType.State;
        getTotalTime(): number;
        hide?(options?: BaseOptions): void | Promise<void>;
        load(data: PluginTemplateType.ServerData): Promise<void>;
        loadTrajectory(trajectory: Trajectory): void;
        pause(): void;
        play(): void;
        playByTimestamp(): void;
        resetPlayingState(): void;
        setPlayingState(playingState: Partial<PlayingState>): void;
        setPlayingStateByTimestamp(keyframeIndex: number): void;
        setState?(state: Partial<PluginState>, options?: BaseOptions): void;
        show?(options?: BaseOptions): void | Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentKeyFrame data? five hooks keyframes location nextButOneKeyframe nextKeyframe playbackEndTime playbackStartTime rate skipEnd skipStart startTimestamp state staticPrefix totalDistance trajectory

    Accessors

    config

    Methods

    absoluteUrl appendTo? disable dispose enable findKeyFrameByLocation findKeyFrameByTimestamp getCurrentState getTotalTime hide? load loadTrajectory pause play playByTimestamp resetPlayingState setPlayingState setPlayingStateByTimestamp setState? show?

    Properties

    currentKeyFrame: Keyframe
    data?: any

    当前使用的数据

    five: Five
    hooks: Subscribe<PluginTemplateType.EventMap> = ...

    插件事件钩子

    keyframes: Keyframe[]
    location: number
    nextButOneKeyframe: Keyframe
    nextKeyframe: Keyframe
    playbackEndTime: number
    playbackStartTime: number
    rate: number
    skipEnd: number
    skipStart: number
    startTimestamp: number
    state: PluginTemplateType.State

    插件当前状态

    staticPrefix: string = '//vr-image-4.realsee-cdn.cn'
    totalDistance: number
    trajectory: Trajectory

    Accessors

    • get config(): { rate?: number }

      Returns { rate?: number }

    Methods

    • Parameters

      • url: string

      Returns string

      获取静态资源的url

    • 插件自身DOM添加到父容器

      Parameters

      • wrapper: Element

        Element元素

      Returns void

    • 禁用插件，让插件停止响应交互

      Parameters

      Returns void

    • 销毁插件，移除所有副作用，销毁后将不响应任何 API

      Returns void

    • 启用插件，让插件能够响应交互

      Parameters

      Returns void

    • Parameters

      • location: number

      Returns number | { keyframeIndex: number; progress: number }

    • 根据时间戳找到最近的 keyframe

      Parameters

      • timestamp: number

        时间戳（毫秒）

      Returns number

      keyframe 索引，如果找不到返回 undefined

    • 获取总播放时间（毫秒） 考虑 skipStart 和 skipEnd

      Returns number

      总时间（毫秒），如果轨迹未加载则返回 null

    • 隐藏UI

      Parameters

      Returns void | Promise<void>

    • Parameters

      Returns void

    • Returns void

    • Returns void

    • 基于真实时间戳播放轨迹动画 使用 timeArray 中的时间戳，按照真实时间播放

      Returns void

    • Returns void

    • Parameters

      Returns void

    • 设置时间戳模式的播放状态并继续播放

      Parameters

      • keyframeIndex: number

        目标 keyframe 索引

      Returns void

    • 展示UI

      Parameters

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods