Class ModelMakerPluginInstance

constructor

• new ModelMakerPluginInstance(five, config?): ModelMakerPluginInstance

• Parameters

  • five: Five
  • Optionalconfig: {
        occlusionMode?: "translucence" | "depthTest";
        occlusionVisibility?: boolean | Mode[];
        tagContainerZIndex?: number;
    }

    • OptionalocclusionMode?: "translucence" | "depthTest"

      Description

      当 occlusionVisibility 为true时，以哪种方式显示被遮挡的部分

      Params

      'depthTest': 关闭深度测试, 'translucence': 半透明

      Default

      'translucence'
      Copy

    • OptionalocclusionVisibility?: boolean | Mode[]

      Description

      是否显示遮挡的部分

      Params

      所有模式下都显示被遮挡的部分, false: 所有模式下不显示被遮挡的部分, ['Mapview', ...]: 指定模式下显示被遮挡的部分

      Default

      false
      Copy

    • OptionaltagContainerZIndex?: number

  Returns ModelMakerPluginInstance

group

items

state

可以通过 plugin.state 和 plugin.setState 来获取和设置。
通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
来迎合一些通过数据驱动的场景。
Copy

clear

• clear(): void

• Returns void

disable

• disable(): void

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

  Returns void

dispose

• dispose(): void

• 插件进行销毁

  Returns void

enable

• enable(): void

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

  Returns void

forceFinishBoxAnimation

• forceFinishBoxAnimation(id?, restoreLabels?): void

• Force finish all active box animations immediately

  Parameters

  • Optionalid: string | number

    Optional box item ID. If not provided, finishes all active box animations.
  • restoreLabels: boolean = true

    Whether to restore labels immediately. Defaults to true.

  Returns void

getBoxItems

• getBoxItems(): ModelMakerBoxItem[]

• Returns ModelMakerBoxItem[]

getHighlightedItemId

• getHighlightedItemId(): string | number

• 获取当前高亮的项目ID

  Returns string | number

getItemById

• getItemById(id): MarkerItem

• Parameters

  • id: string | number

  Returns MarkerItem

getPolygonItems

• getPolygonItems(): ModelMakerPolygonItem[]

• Returns ModelMakerPolygonItem[]

getPrismItems

• getPrismItems(): ModelMakerPrismItem[]

• Returns ModelMakerPrismItem[]

hasCustomTagRenderer

• hasCustomTagRenderer(map): boolean

• Parameters

  • map: ItemType

  Returns boolean

hide

• hide(): void

• 隐藏UI

  Returns void

hideAllItems

• hideAllItems(): void

• 隐藏所有模型项目

  Returns void

  Example

  // 隐藏所有项目
  controller.hideAllItems()
  Copy

hideItemsByCondition

• hideItemsByCondition(condition): void

• 根据条件隐藏模型项目

  Parameters

  • condition: ((item: MarkerItem) => boolean)

    判断函数，返回 true 的项目将被隐藏

    • • (item): boolean

      • Parameters

        • item: MarkerItem

        Returns boolean

  Returns void

  Example

  // 隐藏所有 ID 大于 10 的项目
  controller.hideItemsByCondition(item => item.rawData.id > 10)
  
  // 隐藏所有红色的盒子
  controller.hideItemsByCondition(item => 
    item.type === 'box' && item.rawData.object_data.color === '#FF0000'
  )
  Copy

hideItemsByType

• hideItemsByType(itemTypes): void

• 隐藏指定类型的模型

  Parameters

  • itemTypes: ItemType | ItemType[]

    模型类型数组

  Returns void

highlightItem

• highlightItem(id, color?): void

• 高亮指定的模型项目

  Parameters

  • id: string | number

    模型项目的ID
  • color: string = '#FF7700'

    高亮颜色，默认为 #FF7700

  Returns void

load

• load(serverData): Promise<void>

• 加载插件依赖数据

  Parameters

  • serverData: ModelMakerPluginType.ServerData

    插件数据

  Returns Promise<void>

playBoxAnimation

• playBoxAnimation(id?, config?): Promise<void>

• Play the up-and-down animation for a box mesh

  Parameters

  • Optionalid: string | number

    Optional box item ID. If not provided, plays animation for all box items.
  • config: BoxAnimationConfig = {}

    Animation configuration options

  Returns Promise<void>

  Promise that resolves when all animations are complete

registerTagRenderer

• registerTagRenderer(map): void

• Parameters

  • map: Partial<Record<ItemType, ModelMakerPluginType.ElementRenderer>>

  Returns void

resetHighlight

• resetHighlight(): void

• 重置所有高亮

  Returns void

setItemsVisibility

• setItemsVisibility(condition, visible): void

• 根据条件设置模型项目的可见性

  Parameters

  • condition: ((item: MarkerItem) => boolean)

    判断函数，返回 true 的项目将应用指定的可见性状态

    • • (item): boolean

      • Parameters

        • item: MarkerItem

        Returns boolean

  • visible: boolean

    是否可见，true 为显示，false 为隐藏

  Returns void

  Example

  // 隐藏所有小于指定面积的项目
  controller.setItemsVisibility(item => getItemArea(item) < 100, false)
  
  // 显示所有包含特定标签的项目
  controller.setItemsVisibility(item => 
    item.rawData.label?.includes('important'), true
  )
  Copy

setModelsOpacity

• setModelsOpacity(opacityPercent, options?): void

• 设置所有模型的透明度

  Parameters

  • opacityPercent: number

    透明度系数，范围0-1，1表示保持原始透明度，0表示完全透明
  • Optionaloptions: {
        id?: number;
        type?: ItemType | ItemType[];
    }

    可选参数

    • Optionalid?: number

      模型id

    • Optionaltype?: ItemType | ItemType[]

      模型类型，可选值为'box'、'prism'、'triangles'

  Returns void

setState

• setState(targetState): void

• 设置state

  Parameters

  • targetState: Partial<ModelMakerPluginType.State>

  Returns void

show

• show(): void

• 展示UI

  Returns void

showAllItems

• showAllItems(): void

• 显示所有模型项目

  Returns void

  Example

  // 恢复所有项目的可见性
  controller.showAllItems()
  Copy

showItemsByCondition

• showItemsByCondition(condition): void

• 根据条件显示模型项目

  Parameters

  • condition: ((item: MarkerItem) => boolean)

    判断函数，返回 true 的项目将被显示

    • • (item): boolean

      • Parameters

        • item: MarkerItem

        Returns boolean

  Returns void

  Example

  // 显示所有棱柱类型的项目
  controller.showItemsByCondition(item => item.type === 'prism')
  
  // 显示所有透明度大于 0.5 的项目
  controller.showItemsByCondition(item => 
    (item.rawData.object_data.opacity ?? 0.4) > 0.5
  )
  Copy

showItemsByType

• showItemsByType(itemTypes): void

• 显示指定类型的模型

  Parameters

  • itemTypes: ItemType | ItemType[]

    模型类型数组

  Returns void