@vis-three/plugin-object-helper

物体辅助管理插件。

• 此插件会自动识别加入场景的物体，并生成该物体的相关辅助。
• 当物体移出场景时会删除该物体对应的辅助。

:::tip 对于配置化模块，可以不使用此插件，而是使用@vis-three/module-helper，会有更精细的辅助管理功能。 :::

最新版本

license

插件名称

ObjectHelperPlugin

:::tip 可以使用枚举：OBJECT_HELPER_PLUGIN :::

插件依赖

无

插件传参

无

引擎拓展

export interface ObjectHelperEngine extends Engine {
  /**物体辅助管理器 */
  objectHelperManager: ObjectHelperManager;
  /**设置物体辅助显示隐藏 */
  setObjectHelper: (show: boolean) => ObjectHelperEngine;
}

ObjectHelperManager

addFilteredObject

▸ addFilteredObject(...objects): ObjectHelperManager

@description: 添加过滤的物体

Parameters

| Name | Type | Description | | :----------- | :--------------------- | :----------- | | ...objects | Object3D<Event>[] | three object |

Returns

ObjectHelperManager

this

addObjectHelper

▸ addObjectHelper(object): null | Object3D<Event>

添加物体辅助

Parameters

| Name | Type | | :------- | :------------------- | | object | Object3D<Event> |

Returns

null | Object3D<Event>

three object or null

dispose

▸ dispose(): void

释放所有管理器资源

Returns

void

disposeObjectHelper

▸ disposeObjectHelper(object): null | Object3D<Event>

@description: 销毁物体辅助

Parameters

| Name | Type | Description | | :------- | :------------------- | :----------- | | object | Object3D<Event> | three object |

Returns

null | Object3D<Event>

three object or null