Class BookmarkManager

相机书签管理功能

Constructors

constructor

Properties

bookmarkList json viewer

Methods

add createBookmark getBookmark getBookmarkList getSceneImage loadMark removeBookmark saveMark

Constructors

constructor

  • new BookmarkManager(viewer, bookmarkList): BookmarkManager

  • Parameters

    • viewer: Viewer

      当前viewer

    • bookmarkList: BookmarkType[]

      初始书签列表

    Returns BookmarkManager

Properties

Private bookmarkList

bookmarkList: BookmarkType[]

Private json

json: MarkJsonType = ...

Private viewer

viewer: Viewer

Methods

add

  • add(bookmark): void

  • 将书签加入书签列表

    Parameters

    • bookmark: BookmarkType

      新的书签

    Returns void

createBookmark

  • createBookmark(name, height, width): Promise<unknown>

  • 创建书签

    Parameters

    • name: string

      书签名称

    • height: number

      场景截图canvas高度

    • width: number

      场景截图canvas宽度

    Returns Promise<unknown>

    返回一个新的相机书签

getBookmark

  • getBookmark(id): undefined | BookmarkType

  • 获取指定书签

    Parameters

    • id: number

      书签id

    Returns undefined | BookmarkType

    指定id的书签

getBookmarkList

  • getBookmarkList(): BookmarkType[]

  • 获取书签列表

    Returns BookmarkType[]

    当前书签列表

Private getSceneImage

  • getSceneImage(height, width): Promise<unknown>

  • 创建书签时当前场景截图

    Parameters

    • height: number

      canvas高度

    • width: number

      canvas宽度

    Returns Promise<unknown>

loadMark

  • loadMark(callback?): MarkJsonType

  • 读取MarkJsonType格式加入书签列表中

    Parameters

    • callback: CallBackType = ...

      (可选)第一个参数为MarkJsonType中的description,第二个参数为JSON中当前书签在书签列表中的存储索引

    Returns MarkJsonType

removeBookmark

  • removeBookmark(id): void

  • 从书签列表中移除指定id的书签

    Parameters

    • id: number

      指定书签的id

    Returns void

saveMark

  • saveMark(filsName, markList?, description?): void

  • 存储json格式的视角书签

    Parameters

    • filsName: string

      保存的文件名

    • markList: BookmarkType[] = ...

      (可选)要保存的书签列表，默认全部保存

    • description: {} = {}

      （可选）描述

      Returns void

      待存储的书签json

    Settings

    Member Visibility

    Theme

    On This Page

    constructorbookmarkListjsonvieweraddcreateBookmarkgetBookmarkgetBookmarkListgetSceneImageloadMarkremoveBookmarksaveMark