场景预设插件

场景预设是对场景初始化时的一些属性设置的一个集成插件。便于用户修改预定义的场景设置和对场景属性进行特殊赋值,以达到一些特殊的效果。

场景预设插件

场景预设是对场景初始化时的一些属性设置的一个集成插件。便于用户修改预定义的场景设置和对场景属性进行特殊赋值,以达到一些特殊的效果。

1. 功能说明

场景预设从表现、场景、效果、交互四个方面对场景属性进行集成,其中包括图层渲染、点击聚焦等众多功能点,具体可查看后续属性参数说明。

2. 构造

在SDK中实例化场景预设插件,代码示例如下:

const settingPlugin = new ubm.SceneSettingPlugin()

3. 属性

属性类型可选说明
parameterISceneSettingParameter--参数

3.1 参数

场景预设参数ISceneSettingParameter的数据结构如下:

interface ISceneSettingParameter {
  // 是否显示模型边缘线
  edges: boolean;
  // 模型边缘线颜色
  edgesColor: string;
  // 渲染风格:默认'default', 动画'cartoon', 素描'sketch', 科技'technology'
  theme: 'default' | 'cartoon' | 'sketch' | 'technology';
  // 渲染质量:均衡'medium'(默认), 流畅'low', 画质'high'
  renderQuality: 'low' | 'medium' | 'high';
  // 背景颜色
  bgColor: string;
  // 高亮颜色
  highlightColor: string;
  // 界面风格:亮色主题'light', 深色主题'dark'
  interfaceTheme: string;
  // 是否显示天空
  sky: boolean;
  // 是否显示帧率
  fps: number;
  // 环境光强度
  envLightStrength: number;
  // 是否显示阴影
  shadow: boolean;
  // 是否显示菜单
  contextMenu: false;
  // 鼠标滚动方向, 默认为false
  mouseWheel: boolean;
  // 鼠标是否单击聚焦, 默认为false
  clickFocus: boolean;
  // 是否有选中呼吸效果, 默认为false
  selectBreath: boolean
}

4. 方法

方法说明
update()更新

4.1 更新

update(data: ISceneSettingParameter): void

参数data即属性parameter

更新场景预设插件,代码示例如下:

settingPlugin.model.update({
  edges: true,
  edgesColor: '#eeeeee',
  theme: 'default',
  renderQuality: 'low',
  bgColor: '#407BFF',
  highlightColor: '#407BFF',
  interfaceTheme: 'dark',
  sky: true,
  frameRate: true,
  envLightStrength: 10,
  shadow: true,
  contextMenu: false,
  mouseWheel: false,
  clickFocus: false
})

BIMFlux AI