# ESSeparateFoliage（单体控制森林）

> 分类：**服务图层对象** | 引擎：UE | 基类：否
> 继承链：`Destroyable -> ESSceneObject -> ESVisualObject -> ESSeparateFoliage`

ESSeparateFoliage 是用于管理和控制森林中单体树木（添加、砍伐、生长模拟）的对象。

## JSON 示例

```json
{
            "id": "separatefoliage_xxx",
            "type": "ESSeparateFoliage",
            "name": "单体控制森林",
            "treeTypes": [{"name": "杨树", "meshPath": "/Game/Foliage/Poplar"}]
        }
```

## 属性

| 属性 | 类型 | 默认值 | 说明 | 来源 |
| --- | --- | --- | --- | --- |
| `allowPicking` | boolean | false | 是否允许拾取 默认false | ESVisualObject |
| `collision` | boolean | true | 是否开启碰撞监测 默认true ,主要是UE使用 | ESVisualObject |
| `devTags` | string[] \| undefined | undefined | 对象类型名称相关的开发标签数组，使用 reactArrayWithUndefined 进行响应式处理，默认为 undefined。 | ESSceneObject |
| `execOnceFuncStr` | string \| undefined | undefined | 一次性执行函数的字符串表示，默认为 undefined。 | ESSceneObject |
| `extras` | JsonValue | undefined | 扩展属性 JSON，必须整体赋值，使用 reactJson 进行响应式处理，默认为 undefined。 | ESSceneObject |
| `flyInParam` | ESJFlyInParam \| undefined | undefined | 飞入参数 | ESVisualObject |
| `flyToParam` | ESJFlyToParam \| undefined | undefined | 飞向参数 | ESVisualObject |
| `intervalTime` | number | 0.1 | 动画间隔时间 | ESSeparateFoliage |
| `name` | string | "未命名场景对象" | 对象名称，默认为 '未命名场景对象'。 | ESSceneObject |
| `ref` | string \| undefined | undefined | 对象引用，设置后可通过对象管理器 objm.$refs.xxx 快速获取到对象，默认为 undefined。 | ESSceneObject |
| `show` | boolean | true | 是否显示 默认true | ESVisualObject |
| `stumpId` | - | -1 | 树桩id | ESSeparateFoliage |
| `switchIntervalTime` | number | 0.5 | 切换间隔时间 | ESSeparateFoliage |
| `toDestroyFuncStr` | string \| undefined | undefined | 销毁函数的字符串表示，默认为 undefined。 | ESSceneObject |
| `treeTypes` | ESTreeTypeSep[] \| undefined | [] | 树类型数组 | ESSeparateFoliage |
| `updateFuncStr` | string \| undefined | undefined | 更新函数的字符串表示，默认为 undefined。 | ESSceneObject |

## 方法

| 方法 | 参数 | 返回 | 说明 | 来源 |
| --- | --- | --- | --- | --- |
| `addToViewer(viewer: ESViewer)` | viewer: ESViewer | - | 将对象添加到指定视口中。<br>**参数**：viewer - 要添加对象的视口。 | ESSceneObject |
| `addTrees(TreeParams: ESTreeParam[])` | TreeParams: ESTreeParam[] | - | 触发添加树的事件。<br>**参数**：TreeParams - 要添加的树的参数数组。 | ESSeparateFoliage |
| `addTreesCallFunc(ueViewer: any, trees: ESTreeParam[])` | ueViewer: any, trees: ESTreeParam[] | - | 调用添加树的函数。<br>**参数**：ueViewer - UE查看器对象。；trees - 要添加的树的参数数组。<br>**返回**：一个Promise，解析为添加树操作的结果。 | ESSeparateFoliage |
| `calcFlyInParam()` | - | - | 触发计算飞入参数事件 | ESVisualObject |
| `calcFlyToParam()` | - | - | 触发计算飞向参数事件 | ESVisualObject |
| `createAttachedObject(createViewerPropSceneObject: (viewer: ESViewer) => Destroyable | undefined)` | createViewerPropSceneObject: (viewer: ESViewer) => Destroyable \| undefined | - | 创建与视口关联的对象，并返回一个销毁函数，用于手动销毁关联对象。<br>**参数**：createViewerPropSceneObject - 一个函数，用于创建与视口关联的对象。<br>**返回**：一个销毁函数，调用该函数可以销毁所有关联对象。 | ESSceneObject |
| `cutDownTrees(TreeId: ToCutDownScaleType[], TimeLength: number)` | TreeId: ToCutDownScaleType[], TimeLength: number | - | 触发砍伐树的事件。<br>**参数**：TreeId - 要砍伐的树的ID数组。；TimeLength - 砍伐操作的时间长度。 | ESSeparateFoliage |
| `cutDownTreesCallFunc(ueViewer: any, TreeIds: ToCutDownScaleType[], TimeLength: number)` | ueViewer: any, TreeIds: ToCutDownScaleType[], TimeLength: number | - | 调用砍伐树的函数。<br>**参数**：ueViewer - UE查看器对象。；TreeIds - 要砍伐的树的ID数组。；TimeLength - 砍伐操作的时间长度。<br>**返回**：一个Promise，解析为砍伐树操作的结果。 | ESSeparateFoliage |
| `emptyFlyInParam()` | - | - | 清空飞入参数 | ESVisualObject |
| `emptyFlyToParam()` | - | - | 清空飞向参数 | ESVisualObject |
| `flush()` | - | - | 刷新对象，触发刷新事件。 | ESSceneObject |
| `flyIn(duration: number = 1)` | duration: number = 1 | - | 触发飞入事件<br>**参数**：duration - 飞入持续时间，默认为 1 | ESVisualObject |
| `flyTo(duration: number = 1)` | duration: number = 1 | - | 触发飞向事件<br>**参数**：duration - 飞向持续时间，默认为 1 | ESVisualObject |
| `getBoundSphere(viewer: ESViewer)` | viewer: ESViewer | - | 获取对象的边界球<br>**参数**：viewer - 视图器对象<br>**返回**：包含边界球信息的 Promise | ESVisualObject |
| `getESProperties()` | - | - | 获取对象的属性列表。 | ESSeparateFoliage |
| `getIdByComponentNameAndHitItem(viewer: any, ComponentName: string, HitItem: number)` | viewer: any, ComponentName: string, HitItem: number | - | 通过组件名称和命中项获取ID。<br>**参数**：viewer - 查看器对象。；ComponentName - 组件名称。；HitItem - 命中项。<br>**返回**：一个Promise，解析为获取ID操作的结果。 | ESSeparateFoliage |
| `growthSimulation(ToParams: ToScaleType[], TimeLength: number, SwitchTime: number)` | ToParams: ToScaleType[], TimeLength: number, SwitchTime: number | - | 触发树木生长模拟的事件。<br>**参数**：ToParams - 生长模拟的参数数组。；TimeLength - 生长模拟的时间长度。；SwitchTime - 切换时间。 | ESSeparateFoliage |
| `growthSimulationCallFunc(ueViewer: any, ToParams: ToScaleType[], TimeLength: number, SwitchTime: number)` | ueViewer: any, ToParams: ToScaleType[], TimeLength: number, SwitchTime: number | - | 调用树木生长模拟的函数。<br>**参数**：ueViewer - UE查看器对象。；ToParams - 生长模拟的参数数组。；TimeLength - 生长模拟的时间长度。；SwitchTime - 切换时间。<br>**返回**：一个Promise，解析为生长模拟操作的结果。 | ESSeparateFoliage |
| `registerAttachedObject(createViewerPropSceneObject: (viewer: ESViewer) => Destroyable | undefined)` | createViewerPropSceneObject: (viewer: ESViewer) => Destroyable \| undefined | - | 注册与视口关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。<br>**参数**：createViewerPropSceneObject - 一个函数，用于创建与视口关联的对象。 | ESSceneObject |
| `registerAttachedObjectForContainer(createContainerPropSceneObject: (viewer: ESViewer, container: HTMLDivElement) => Destroyable | undefined)` | createContainerPropSceneObject: (viewer: ESViewer, container: HTMLDivElement) => Destroyable \| undefined | - | 注册与视口容器关联的对象，当对象被添加到视口或从视口移除时，会自动创建或销毁关联对象。<br>**参数**：createContainerPropSceneObject - 一个函数，用于创建与视口容器关联的对象。 | ESSceneObject |
| `reload()` | - | - | - | ESSceneObject |
| `removeAllTrees()` | - | - | 触发移除所有树的事件。 | ESSeparateFoliage |
| `removeAllTreesCallFunc(ueViewer: any)` | ueViewer: any | - | 调用移除所有树的函数。<br>**参数**：ueViewer - UE查看器对象。<br>**返回**：一个Promise，解析为移除所有树操作的结果。 | ESSeparateFoliage |
| `removefromViewer(viewer: ESViewer)` | viewer: ESViewer | - | 将对象从指定视口中移除。<br>**参数**：viewer - 要移除对象的视口。 | ESSceneObject |
| `supportEditingModes()` | - | - | 获取当前对象支持的编辑模式<br>**返回**：支持的编辑模式数组 | ESVisualObject |
| `updateEditing()` | - | - | 更新编辑状态的方法，具体实现由子类完成 | ESVisualObject |
| `updateTreeParams(TreeParams: ESTreeParam[])` | TreeParams: ESTreeParam[] | - | 触发更新树参数的事件。<br>**参数**：TreeParams - 要更新的树的参数数组。 | ESSeparateFoliage |
| `updateTreeParamsCallFunc(ueViewer: any, trees: ESTreeParam[])` | ueViewer: any, trees: ESTreeParam[] | - | 调用更新树参数的函数。<br>**参数**：ueViewer - UE查看器对象。；trees - 要更新的树的参数数组。<br>**返回**：一个Promise，解析为更新树参数操作的结果。 | ESSeparateFoliage |

## 事件

| 事件 | 说明 | 来源 |
| --- | --- | --- |
| `activeViewerChanged` | - | ESSceneObject |
| `addTreesEvent` | 获取添加树的事件。 | ESSeparateFoliage |
| `calcFlyInParamEvent` | 获取计算飞入参数事件 | ESVisualObject |
| `calcFlyToParamEvent` | 获取计算飞向参数事件 | ESVisualObject |
| `createdEvent` | 获取对象创建事件。 | ESSceneObject |
| `cutDownTreesEvent` | 获取砍伐树的事件。 | ESSeparateFoliage |
| `editingChanged` | 获取编辑状态改变事件 | ESVisualObject |
| `flushEvent` | 获取刷新对象事件。 | ESSceneObject |
| `flyInEvent` | 获取飞入事件 | ESVisualObject |
| `flyOverEvent` | 获取飞行结束事件 | ESVisualObject |
| `flyToDistanceChanged` | 获取飞向距离改变事件 | ESVisualObject |
| `flyToEvent` | 获取飞向事件 | ESVisualObject |
| `flyToFlyDurationChanged` | 获取飞向持续时间改变事件 | ESVisualObject |
| `flyToHDeltaChanged` | 获取飞向水平偏移量改变事件 | ESVisualObject |
| `flyToHeadingChanged` | 获取飞向航向改变事件 | ESVisualObject |
| `flyToPDeltaChanged` | 获取飞向垂直偏移量改变事件 | ESVisualObject |
| `flyToPitchChanged` | 获取飞向俯仰角改变事件 | ESVisualObject |
| `growthSimulationEvent` | 获取树木生长模拟的事件。 | ESSeparateFoliage |
| `pickedEvent` | 获取拾取事件 | ESVisualObject |
| `readyEvent` | - | ESSceneObject |
| `reloadEvent` | - | ESSceneObject |
| `removeAllTreesEvent` | 获取移除所有树的事件。 | ESSeparateFoliage |
| `toDestroyFuncChanged` | 获取销毁函数改变事件。 | ESSceneObject |
| `updateFuncChanged` | 获取更新函数改变事件。 | ESSceneObject |
| `updateTreeParamsEvent` | 获取更新树参数的事件。 | ESSeparateFoliage |

---
> 本文由 `generate-docs.mjs` 从源码自动生成，请勿手改。修改对象属性/方法后重跑脚本刷新。