EarthSDK

https://www.earthsdk.com
Admin
EarthSDK is a 3D geospatial visualization framework supporting multiple rendering engines including...
Tokens:422,441
Snippets:2,147
Trust Score:6.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### start

Source: https://www.earthsdk.com/docs/classes/earthsdk3.Throttling.html

Starts a function execution cycle.

```APIDOC
## start

### Description
Starts a function execution cycle.

### Parameters
- **...args** ([func: (...args: T) => void, time: number]) - Required - Function and interval time.

### Returns
- **void**
```

--------------------------------

### CursorInfo Usage Example

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CursorInfo.html

Example demonstrating how to instantiate and use the CursorInfo class, including defining a custom div class.

```APIDOC
## Example Usage

### Default CursorFloatDiv
```typescript
// Default uses CursorFloatDiv, code can be simplified as follows:
const cursorInfo = new CursorInfo(div, CursorFloatDiv);
```

### Custom Div Class
```typescript
// Users can define their own classes, similar to CursorFloatDiv:
class CustomCursorDiv extends PosFloatDiv {
    constructor() {
        super();

        this.contentDiv.style.backgroundColor = 'rgba(0, 0, 0, 0.8)';
        this.contentDiv.style.borderRadius = '3px';
        this.contentDiv.style.color = 'rgb(255, 255, 255)';
        this.contentDiv.style.padding = '1px 5px 1px 5px';
        this.contentDiv.style.fontSize = '12px';
        this.contentDiv.style.whiteSpace = 'nowrap';

        this.contentDiv.innerText = `Undefined cursor information!`;
        this.originRatioX = 0;
        this.originRatioY = 0;
        this.originOffsetX = -16;
    }
}

// Instantiate CursorInfo with the custom div class:
const cursorInfo = new CursorInfo<CustomCursorDiv>(div, CustomCursorDiv);
```

### Parameters for Constructor
* `container`: HTMLDivElement - The DOM element that will contain the cursor info.
* `divClass`: FloatDivClass<DivClass> - The class constructor for the custom div. It must extend `PosFloatDiv`.
```

--------------------------------

### Start and Status Events

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESTerrainLayerEditing.html

APIs related to the start event, object disabling status, and destruction.

```APIDOC
## GET /startEvent

### Description
Gets the start event.

### Method
GET

### Endpoint
/startEvent

### Response
#### Success Response (200)
- **startEvent** (Event<[]>) - The start event.
```

```APIDOC
## GET /statusDis

### Description
Gets the disabled status of the object.

### Method
GET

### Endpoint
/statusDis

### Response
#### Success Response (200)
- **statusDis** (boolean) - True if the object is disabled, false otherwise.
```

```APIDOC
## GET /statusDisChanged

### Description
Gets the listener for changes in the object's disabled status.

### Method
GET

### Endpoint
/statusDisChanged

### Response
#### Success Response (200)
- **statusDisChanged** (Listener<[boolean, boolean]>) - Listener for disabled status changes.
```

```APIDOC
## GET /toDestroyEvent

### Description
Gets the event triggered when the object is to be destroyed.

### Method
GET

### Endpoint
/toDestroyEvent

### Response
#### Success Response (200)
- **toDestroyEvent** (Listener) - Listener for the destroy event.
```

--------------------------------

### ESImageLabel Class Overview

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESImageLabel.html

Provides an overview of the ESImageLabel class, its inheritance, core functionalities, and usage examples.

```APIDOC
## Class ESImageLabel

ESImageLabel 图片标签类

继承自 ESLabel 的图片标签组件，用于在场景中显示图片标签。该类提供了图片显示的基本功能， 包括图片路径设置、锚点定位、渲染模式配置等核心功能。

### 核心功能

* 图片路径管理：支持设置和获取图片资源路径
* 锚点定位：支持设置图片的锚点位置
* 渲染模式：支持多种渲染模式配置
* 属性管理：提供完整的属性获取和设置机制

### 使用示例

构造函数参数：
#### 参数: id
可选的场景对象键值，用于标识场景中的唯一对象

注意事项：
* 默认图片路径为内置的 "inner://CameraBlue.png"
* 默认锚点为 [0.5, 1]，即水平居中、底部对齐
* 默认渲染模式为 4
* 该类支持 Cesium 和 UE 引擎实现

#### 层级 (查看层级一览, 展开)

* ESLabel
* UniteChanged<ReturnType<typeof createDefaultProps>>
  * ESImageLabel

##### 索引

### 构造函数
constructor

### 属性
_deprecated actorTag actorTagChanged actorTagReact allowPicking allowPickingChanged allowPickingReact anchor anchorChanged anchorReact collision collisionChanged collisionReact devTags devTagsChanged devTagsReact editingBindMode editingID execOnceFuncStr execOnceFuncStrChanged execOnceFuncStrReact extras extrasChanged extrasReact flyInParam flyInParamChanged flyInParamReact flyToParam flyToParamChanged flyToParamReact hoverHighlight hoverHighlightChanged hoverHighlightReact isHoverZoom isHoverZoomChanged isHoverZoomReact maxVisibleDistance maxVisibleDistanceChanged maxVisibleDistanceReact minVisibleDistance minVisibleDistanceChanged minVisibleDistanceReact name nameChanged nameReact offset offsetChanged offsetReact pointed pointedChanged pointedReact pointStyle pointStyleChanged pointStyleReact position positionChanged positionOffset positionOffsetChanged positionOffsetReact positionReact ref refChanged refReact renderMode renderModeChanged renderModeReact rotation rotationChanged rotationOffset rotationOffsetChanged rotationOffsetReact rotationReact rotationType rotationTypeChanged rotationTypeReact scale scaleChanged scaleReact screenRender screenRenderChanged screenRenderReact show showChanged showReact size sizeByContent sizeByContentChanged sizeByContentReact sizeChanged sizeReact socketName socketNameChanged socketNameReact toDestroyFuncStr toDestroyFuncStrChanged toDestroyFuncStrReact updateFuncStr updateFuncStrChanged updateFuncStrReact url urlChanged urlReact useCalcFlyToParamInESObjectWithLocation zOrder zOrderChanged zOrderReact _lastFlyInId _lastFlyToId _lastMemId context create createFromClass createFromJson createFromUrl defaultFlyInParam defaultFlyToParam defaults destroySceneObject getEnv getSceneObj getSceneObjById getSceneObject getSceneObjectById getStrFromEnv innerRegister setEnv supportEditingModes type

### 访问器
_jsonStr activeViewer activeViewerChanged attachedViewers automaticLandingEvent calcFlyInParamEvent calcFlyToParamEvent completeJson components createdEvent defaultProps disposers editing editingChanged flushEvent flyInEvent flyOverEvent flyToDistance flyToDistanceChanged flyToEvent flyToFlyDuration flyToFlyDurationChanged flyToHDelta flyToHDeltaChanged flyToHeading flyToHeadingChanged flyToPDelta flyToPDeltaChanged flyToPitch flyToPitchChanged id json memId parentID pickedEvent pointColor pointColorChanged pointMaterial pointMaterialChanged pointMaterialParams pointMaterialParamsChanged pointSize pointSizeChanged pointSizeType pointSizeTypeChanged smoothMoveEvent smoothMoveKeepPitchEvent smoothMoveOnGroundEvent smoothMoveRelativelyEvent smoothMoveRelativelyWithRotationEvent smoothMoveWithRotationEvent smoothMoveWithRotationOnGroundEvent statusDis statusDisChanged toDestroyEvent toDestroyFunc toDestroyFuncChanged typeName updateFunc updateFuncChanged viewerAttached viewerDetached widgetEvent $refs envs

### 方法
_deprecatedWarning ad addToViewer autoDispose automaticLanding calcFlyInParam calcFlyToParam createAttachedObject d destroy destroyImp dispose disposeVar dv emptyFlyInParam emptyFlyToParam flush flyIn flyTo getBoundSphere getESProperties isDestroyed registerAttachedObject registerAttachedObjectForContainer removefromViewer smoothMove smoothMoveKeepPitch smoothMoveOnGround smoothMoveRelatively smoothMoveRelativelyWithRotation smoothMoveWithRotation smoothMoveWithRotationOnGround supportEditingModes tdv tryDestory tryDisposeVar updateEditing createDefaultProps getParentClass register
```

--------------------------------

### Lifecycle Management Methods

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ThrottlingWithStartValues.html

Methods for starting, restarting, and managing the lifecycle of SDK components.

```APIDOC
## restart

### Description
Restarts the component execution.

### Parameters
- **cancelError** (CancelError) - Optional - Error object to handle cancellation.
- **args** (Array) - Optional - Additional arguments.

### Response
- **void** - Returns nothing.

## restartIfNotRunning

### Description
Restarts the component only if it is not currently running.

### Parameters
- **args** (Array) - Optional - Additional arguments.

### Response
- **void** - Returns nothing.

## start

### Description
Starts the component execution.

### Parameters
- **args** (Array) - Optional - Additional arguments.

### Response
- **void** - Returns nothing.
```

--------------------------------

### Constructor - new CzmESNavigator

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESNavigator.html

Initializes a new instance of the CzmESNavigator class.

```APIDOC
## CONSTRUCTOR new CzmESNavigator

### Description
Creates a new CzmESNavigator instance associated with a specific scene object and viewer.

### Parameters
#### Path Parameters
- **sceneObject** (ESNavigator) - Required - The scene object to associate with the engine object.
- **czmViewer** (ESCesiumViewer) - Required - The viewer to associate with the engine object.

### Request Example
new CzmESNavigator(sceneObject, czmViewer);
```

--------------------------------

### Constructor: new XbsjGroundPolylinePrimitive

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.XbsjGroundPolylinePrimitive.html

Initializes a new instance of the XbsjGroundPolylinePrimitive class.

```APIDOC
## Constructor: new XbsjGroundPolylinePrimitive

### Description
Creates a new XbsjGroundPolylinePrimitive instance with optional configuration settings.

### Parameters
#### Request Body
- **options** (object) - Optional - Configuration object containing properties like allowPicking, appearance, asynchronous, classificationType, debugShowBoundingVolume, debugShowShadowVolume, geometryInstances, interleave, releaseGeometryInstances, and show.

### Response
- **XbsjGroundPolylinePrimitive** (object) - The initialized primitive instance.
```

--------------------------------

### GET /flyToDistance

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESExcavate.html

Gets or sets the fly-to distance parameter.

```APIDOC
## GET/SET /flyToDistance

### Description
Gets or sets the fly-to distance.

### Parameters
#### Request Body
- **value** (number | undefined) - The fly-to distance value.

### Response
- **number | undefined** - The current fly-to distance.
```

--------------------------------

### POST /startEditing

Source: https://www.earthsdk.com/docs/types/earthsdk3-ue.UeFuncsType.html

Initiates the editing mode for a specific scene object.

```APIDOC
## POST /startEditing

### Description
Initiates the editing mode for a specific scene object.

### Parameters
#### Request Body
- **editingID** (string) - Required - ID for the editing session
- **modes** (string[] | string) - Required - Editing modes to enable
- **sceneObjectID** (string) - Required - ID of the object to edit
- **useKeyToSwitch** (boolean) - Optional - Whether to use a key to switch modes

### Response
#### Success Response (200)
- **error** (string) - Error message if operation fails
```

--------------------------------

### Example Usage of step Function

Source: https://www.earthsdk.com/docs/functions/earthsdk3.step.html

This example demonstrates how to use the step function to chain asynchronous operations, including event listeners for pointer events, and managing their disposal.

```typescript
await nextAsync(cancelsManager, async cancelsManager => {
      cancelsManager.disposer.dispose(czmViewer.interaction.pointerMoveEvent.disposableOn(pointerEvent => {
          computePickingInfo(pointerEvent, scene, mainCoordinates, coordinatesEditor.axisSnapPixelSize, pickingInfo);
          setCoordinatesColor(mainCoordinates, pickingInfo.constraintMode);
      }));

      await nextAsync(cancelsManager, cancelsManager => {
          return new Promise<void>(resolve => {
              cancelsManager.disposer.dispose(czmViewer.interaction.pointerDownEvent.disposableOn(pointerEvent => {
                  computePickingInfo(pointerEvent, scene, mainCoordinates, coordinatesEditor.axisSnapPixelSize, pickingInfo);
                  if (pickingInfo.constraintMode !== 'none') {
                      resolve();
                  }
              }));
          });
      });
  });
```

--------------------------------

### PosFloatDiv Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3.PosFloatDiv.html

Information on how to instantiate the PosFloatDiv class.

```APIDOC
## Constructor

### `new PosFloatDiv()`

Creates a new instance of PosFloatDiv.

#### Returns
- `PosFloatDiv`: A new PosFloatDiv object.
```

--------------------------------

### GET/SET /pointColor

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESExcavate.html

Gets or sets the color of the point.

```APIDOC
## GET/SET /pointColor

### Description
Gets or sets the color of the point.

### Parameters
#### Request Body
- **value** ([number, number, number, number]) - The color value as an array of four numbers.

### Response
- **[number, number, number, number]** - The current point color.
```

--------------------------------

### Constructor: new OlGeoCanvasMenuPoi

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ol.OlGeoCanvasMenuPoi.html

Initializes a new instance of the OlGeoCanvasMenuPoi class.

```APIDOC
## constructor

### Description
Creates a new OlGeoCanvasMenuPoi instance associated with the provided viewer.

### Parameters
#### Path Parameters
- **olViewer** (ESOlViewer) - Required - The viewer instance to attach the menu point to.

### Response
- **Returns** (OlGeoCanvasMenuPoi) - The created instance.
```

--------------------------------

### GET /id

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESExcavate.html

Retrieves the unique identifier of the object.

```APIDOC
## GET /id

### Description
Retrieves the unique identifier of the object.

### Response
- **string** - The unique identifier.
```

--------------------------------

### Constructor: ESCustomDiv

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESCustomDiv.html

Initializes a new instance of the ESCustomDiv class.

```APIDOC
## constructor

### Description
Initializes a new ESCustomDiv instance.

### Method
new

### Parameters
#### Path Parameters
- **id** (string) - Optional - The unique identifier for the instance.

### Response
- **ESCustomDiv** (Object) - Returns an instance of ESCustomDiv.
```

--------------------------------

### GET area

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESDirectionMeasurement.html

Retrieves the area of the geographic vector.

```APIDOC
## GET area

### Description
Returns the calculated area of the geographic vector.

### Response
- **number** - The area value.
```

--------------------------------

### Constructor: ESVideoFusion

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESVideoFusion.html

Initializes a new instance of the ESVideoFusion class.

```APIDOC
## constructor

### Description
Initializes a new video fusion object in the 3D scene.

### Method
Constructor

### Parameters
#### Path Parameters
- **id** (string) - Optional - The unique identifier for the scene object.

### Response
- **ESVideoFusion** - Returns an instance of the ESVideoFusion class.
```

--------------------------------

### GET /fillColor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.ESGeoSmoothPolygon.html

Manages the fill color property of the object.

```APIDOC
## GET /fillColor

### Description
Retrieves the current fill color as an RGBA array.

### Method
GET

### Response
#### Success Response (200)
- **fillColor** ([number, number, number, number]) - The RGBA color values.

## SET /fillColor

### Description
Sets the fill color of the object.

### Method
SET

### Parameters
#### Request Body
- **value** ([number, number, number, number]) - Required - The new RGBA color values.
```

--------------------------------

### PointAdding Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ol.PointAdding.html

Initializes a new instance of the PointAdding class.

```APIDOC
## constructor PointAdding

### Description
Initializes a new instance of the PointAdding class.

### Method
constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### GET /editing

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.ESGeoSmoothPolygon.html

Manages the editing state of the scene object.

```APIDOC
## GET /editing

### Description
Retrieves the current editing state of the object.

### Method
GET

### Response
#### Success Response (200)
- **editing** (boolean) - The current editing state.

## SET /editing

### Description
Updates the editing state of the object.

### Method
SET

### Parameters
#### Request Body
- **value** (boolean) - Required - The new editing state.
```

--------------------------------

### GET/SET /json

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESExcavate.html

Gets or sets the object's JSON representation.

```APIDOC
## GET/SET /json

### Description
Gets or sets the object's JSON representation.

### Parameters
#### Request Body
- **value** (JsonValue) - The JSON data to set.

### Response
- **JsonValue** - The JSON representation of the object.
```

--------------------------------

### UeCloudViewerBase Class Overview

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeCloudViewerBase.html

Provides an overview of the UeCloudViewerBase class, its inheritance, and a link to its detailed documentation.

```APIDOC
## Class UeCloudViewerBase `abstract`

### Description
This is an abstract class that serves as a base for cloud viewer functionalities in EarthSDK.

### Inheritance
- Destroyable
  - UeCloudViewerBase

### Documentation Link
https://www.wolai.com/earthsdk/3CCBudoKrPvJGLAk3sCAdT
```

--------------------------------

### Constructor - UeESBlastParticleSystem

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeESBlastParticleSystem.html

Initializes a new instance of the UeESBlastParticleSystem class.

```APIDOC
## constructor

### Description
Creates a new UeESBlastParticleSystem instance associated with a specific scene object and viewer.

### Parameters
#### Path Parameters
- **sceneObject** (ESBlastParticleSystem) - Required - The scene object to associate with the engine object.
- **ueViewer** (ESUeViewer) - Required - The viewer instance associated with the engine object.

### Response
- **Returns** (UeESBlastParticleSystem) - The newly created instance.
```

--------------------------------

### GET defaultProps

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESDirectionMeasurement.html

Retrieves the default configuration properties for the scene object.

```APIDOC
## GET defaultProps

### Description
Returns the default properties including name, ref, and functional strings.

### Response
- **devTags** (ReactiveVariable) - Development tags.
- **name** (string) - Object name.
- **ref** (string) - Object reference identifier.
```

--------------------------------

### Constructor: new CzmPoint

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmPoint.html

Initializes a new instance of the CzmPoint class.

```APIDOC
## constructor

### Description
Creates a new CzmPoint instance to be managed within the specified Cesium viewer.

### Parameters
#### Arguments
- **czmViewer** (ESCesiumViewer) - Required - The Cesium viewer instance.
- **id** (string) - Optional - A unique identifier for the point.

### Response
- **CzmPoint** - Returns the newly created CzmPoint instance.
```

--------------------------------

### GET /_jsonStr

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.ESGeoSmoothPolygon.html

Retrieves or sets the JSON string representation of the object.

```APIDOC
## GET /_jsonStr

### Description
Retrieves the JSON string representation of the object.

### Method
GET

### Endpoint
/_jsonStr

### Response
#### Success Response (200)
- **result** (string) - The JSON string representation.

## SET /_jsonStr

### Description
Sets the object properties based on a JSON string.

### Method
SET

### Parameters
#### Request Body
- **value** (string) - Required - The JSON string to apply.
```

--------------------------------

### GET /fillMaterialParamsChanged

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESExcavate.html

Retrieves the event listener for changes in fill material parameters.

```APIDOC
## GET /fillMaterialParamsChanged

### Description
Retrieves the event listener for changes in fill material parameters.

### Response
- **Listener<[ESJFillStyle, ESJFillStyle]>** - The event listener for fill material parameter changes.
```

--------------------------------

### Static Methods: register and registerEditing

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESClippingPlane.html

Methods to register engine object constructors to the global context for non-editing and editing modes.

```APIDOC
## Static Methods

### Description
Registers an engine object constructor to the global context. If the viewer type and scene object type are already registered, the previous constructor will be overwritten.

### Parameters
- **viewerType** (string) - Required - The type name of the viewer.
- **sceneObjectTypeName** (string) - Required - The type name of the scene object.
- **objConstructor** (Function) - Required - The constructor function for the engine object.
```

--------------------------------

### UeESAlarm Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeESAlarm.html

Details on how to instantiate the UeESAlarm class, including parameters and usage.

```APIDOC
## Constructor

### `new UeESAlarm(sceneObject: ESAlarm, ueViewer: ESUeViewer): UeESAlarm`

Constructs a new instance of the UeESAlarm class.

#### Parameters

*   **sceneObject** (ESAlarm) - The scene object associated with the engine object.
*   **ueViewer** (ESUeViewer) - The Unreal Engine viewer associated with the engine object.

#### Returns

*   UeESAlarm - A new instance of the UeESAlarm class.

#### Special Usage Notes

*   In editing mode, the constructor does not perform initialization.
*   Automatically sets the viewer for the scene object and triggers a viewer change event.
*   Handles the addition and removal of scene object components, ensuring correct association with the viewer.

```

--------------------------------

### Fill Material Management

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESPolygonFlattenedPlane.html

Accessors for getting and setting the fill material of an object.

```APIDOC
## GET /api/object/fill-material

### Description
Gets the fill material of the object.

### Method
GET

### Endpoint
/api/object/fill-material

### Response
#### Success Response (200)
- **fillMaterial** (string) - The name or identifier of the fill material.

## PUT /api/object/fill-material

### Description
Sets the fill material of the object.

### Method
PUT

### Endpoint
/api/object/fill-material

### Parameters
#### Request Body
- **value** (string) - Required - The fill material value to set.
```

--------------------------------

### Manage Fill Color

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESLocalPolygonZ.html

Get or set the fill color of a polygon object.

```typescript
get fillColor(): [number, number, number, number]
set fillColor(value: [number, number, number, number]): void
```

--------------------------------

### UeESDynamicWater Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeESDynamicWater.html

Details on how to instantiate the UeESDynamicWater class, including required parameters and special usage considerations.

```APIDOC
## Constructor

### constructor
  * new UeESDynamicWater(
sceneObject: ESDynamicWater,
ueViewer: ESUeViewer,
): UeESDynamicWater

#### Parameters
    * sceneObject: ESDynamicWater - The scene object associated with the engine object.
    * ueViewer: ESUeViewer - The viewport associated with the engine object.

#### Special Usage Restrictions or Potential Side Effects:
  * In editing mode, the constructor will not perform initialization.
  * The constructor automatically sets the viewport for the scene object and triggers a viewport change event.
  * The constructor handles the addition and deletion of scene object components, ensuring they are correctly associated with the viewport.
```

--------------------------------

### GET /flyToEvents

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESImageLabel.html

Access various flight-related events and parameters for scene navigation.

```APIDOC
## GET /flyToEvents

### Description
Retrieves events related to object flight, such as flyIn, flyOver, and flyTo, along with their associated parameters like distance, duration, and orientation.

### Method
GET

### Endpoint
/flyToEvent, /flyInEvent, /flyOverEvent, /flyToDistance, /flyToHeading, /flyToPitch

### Response
#### Success Response (200)
- **flyInEvent** (Event) - Triggered when object flies in.
- **flyOverEvent** (Event) - Triggered when flight ends.
- **flyToDistance** (number) - Current fly-to distance setting.
```

--------------------------------

### Constructor: ImageProcessing

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ImageProcessing.html

Initializes a new instance of the ImageProcessing class.

```APIDOC
## constructor

### Description
Creates a new ImageProcessing instance for a specific image resource.

### Parameters
- **_complexImage** (ComplexImage) - Required - The complex image object.
- **_imageUri** (string) - Required - The URI of the image to be processed.

### Response
- **Returns** (ImageProcessing) - A new instance of the ImageProcessing class.
```

--------------------------------

### CzmESExcavate ToDestroyEvent Accessor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESExcavate.html

Accessor to get the event that is fired when the object is about to be destroyed.

```typescript
get toDestroyEvent(): Listener
```

--------------------------------

### Constructor ESUeViewer

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.ESUeViewer.html

Initializes a new instance of the ESUeViewer class.

```APIDOC
## constructor

### Description
Creates a new instance of ESUeViewer.

### Parameters
- **option** (ESVOption) - Required - Configuration options for the viewer.

### Returns
- **ESUeViewer** - The initialized viewer instance.
```

--------------------------------

### ESImageLabel Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESImageLabel.html

Initializes a new instance of the ESImageLabel class.

```APIDOC
## 构造函数

### constructor

  * new ESImageLabel(id?: string): ESImageLabel

构造函数，初始化 ESImageLabel 实例。

#### 参数

    * `可选`id: string
场景对象的键值，可选参数。

#### 返回 ESImageLabel
```

--------------------------------

### createProcessingFromPromiseCreateFuncWithStartValues

Source: https://www.earthsdk.com/docs/functions/earthsdk3.createProcessingFromPromiseCreateFuncWithStartValues.html

Creates a processing object from a promise creation function with initial start values.

```APIDOC
## createProcessingFromPromiseCreateFuncWithStartValues

### Description
Creates a Processing object from a function that returns a Promise, accepting initial arguments to pass to the promise creation function.

### Parameters
- **promiseCreateFunc** (function) - Required - A function that returns a Promise, accepting arguments of type StartValueType.
- **...args** (any[]) - Required - The initial arguments to be passed to the promiseCreateFunc.

### Returns
- **Processing<CompleteValueType, []>** - A processing object representing the asynchronous operation.

### Type Parameters
- **CompleteValueType** (void) - The type of the value resolved by the promise.
- **StartValueType** (any[]) - The types of the arguments accepted by the promise creation function.
```

--------------------------------

### UeESNavigator Methods

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeESNavigator.html

Details the various methods available on the UeESNavigator instance for managing its lifecycle and associated resources.

```APIDOC
## Methods

### `ad`

*   `ad(disposeFunc: () => void): () => void`
    *   Adds a function to be called when the object is disposed.
    *   **Parameters:**
        *   `disposeFunc` (() => void) - The function to execute upon disposal.
    *   **Returns:** `() => void` - A function to remove the added disposer.

*   `ad<T extends { destroy(): void }>(obj: T): T`
    *   Adds an object with a `destroy` method to be automatically disposed when the current object is disposed.
    *   **Type Parameters:**
        *   `T` (extends `{ destroy(): void }`) - The type of the object to be disposed.
    *   **Parameters:**
        *   `obj` (T) - The object to auto-dispose.
    *   **Returns:** `T` - The provided object.

### `autoDispose`

*   `autoDispose(disposeFunc: () => void): () => void`
    *   Similar to `ad`, registers a function for disposal.
    *   **Parameters:**
        *   `disposeFunc` (() => void) - The function to execute upon disposal.
    *   **Returns:** `() => void` - A function to remove the added disposer.

*   `autoDispose<T extends { destroy(): void }>(obj: T): T`
    *   Similar to `ad<T>`, registers an object with a `destroy` method for automatic disposal.
    *   **Type Parameters:**
        *   `T` (extends `{ destroy(): void }`) - The type of the object to be disposed.
    *   **Parameters:**
        *   `obj` (T) - The object to auto-dispose.
    *   **Returns:** `T` - The provided object.

### `d`

*   `d(disposeFunc: () => void): () => void`
    *   Alias for `ad` and `autoDispose`.
    *   **Parameters:**
        *   `disposeFunc` (() => void) - The function to execute upon disposal.
    *   **Returns:** `() => void` - A function to remove the added disposer.

### `destroy`

*   `destroy(): undefined`
    *   Initiates the destruction process for the engine object. It is recommended to use `destroyImp` for overriding.
    *   **Returns:** `undefined`

### `destroyImp`

*   `destroyImp(): void`
    *   The implementation method for destroying the engine object. Should be overridden by subclasses.
    *   **Returns:** `void`

### `dispose`

*   `dispose(disposeFunc: () => void): () => void`
    *   Adds a function to be called when the object is disposed.
    *   **Parameters:**
        *   `disposeFunc` (() => void) - The function to execute upon disposal.
    *   **Returns:** `() => void` - A function to remove the added disposer.

### `disposeVar`

*   `disposeVar<T extends { destroy(): void }>(obj: T): T`
    *   Adds an object with a `destroy` method to be automatically disposed when the current object is disposed.
    *   **Type Parameters:**
        *   `T` (extends `{ destroy(): void }`) - The type of the object to be disposed.
    *   **Parameters:**
        *   `obj` (T) - The object to auto-dispose.
    *   **Returns:** `T` - The provided object.

### `dv`

*   `dv<T extends { destroy(): void }>(obj: T): T`
    *   Alias for `disposeVar`.
    *   **Type Parameters:**
        *   `T` (extends `{ destroy(): void }`) - The type of the object to be disposed.
    *   **Parameters:**
        *   `obj` (T) - The object to auto-dispose.
    *   **Returns:** `T` - The provided object.

### `isDestroyed`

*   `isDestroyed(): boolean`
    *   Checks if the engine object has been destroyed.
    *   **Returns:** `boolean` - `true` if destroyed, `false` otherwise.

### `tdv`

*   `tdv<T extends { tryDestroy(): void }>(obj: T): T`
    *   Adds an object with a `tryDestroy` method to be automatically disposed when the current object is disposed.
    *   **Type Parameters:**
        *   `T` (extends `{ tryDestroy(): void }`) - The type of the object to attempt destruction on.
    *   **Parameters:**
        *   `obj` (T) - The object to attempt destruction on.
    *   **Returns:** `T` - The provided object.
```

--------------------------------

### Constructor: CzmPointPrimitiveCollection

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmPointPrimitiveCollection.html

Initializes a new instance of the CzmPointPrimitiveCollection class.

```APIDOC
## constructor

### Description
Creates a new CzmPointPrimitiveCollection instance.

### Parameters
#### Path Parameters
- **czmViewer** (ESCesiumViewer) - Required - The Cesium viewer instance.
- **id** (string) - Optional - A unique identifier for the collection.
```

--------------------------------

### Active Viewer Management

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESPolygonFlattenedPlane.html

Accessors for getting and setting the active viewer and subscribing to changes.

```APIDOC
## GET /api/viewer/active

### Description
Gets the currently active viewer.

### Method
GET

### Endpoint
/api/viewer/active

### Response
#### Success Response (200)
- **activeViewer** (ESViewer | undefined) - The active viewer object or undefined if none is active.

## PUT /api/viewer/active

### Description
Sets the active viewer.

### Method
PUT

### Endpoint
/api/viewer/active

### Parameters
#### Request Body
- **value** (ESViewer | undefined) - Required - The viewer to set as active.
```

--------------------------------

### JSON String Representation

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESPolygonFlattenedPlane.html

Accessor for getting and setting the JSON string representation of an object.

```APIDOC
## GET /api/object/json-string

### Description
Gets the JSON string representation of the object.

### Method
GET

### Endpoint
/api/object/json-string

### Response
#### Success Response (200)
- **jsonStr** (string) - The JSON string representation of the object.

## PUT /api/object/json-string

### Description
Sets the object's properties from a JSON string.

### Method
PUT

### Endpoint
/api/object/json-string

### Parameters
#### Request Body
- **value** (string) - Required - The JSON string to parse and apply to the object.
```

--------------------------------

### Access Object JSON Representation

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESLocalPolygonZ.html

Get or set the JSON string representation of the object.

```typescript
get _jsonStr(): string
set _jsonStr(value: string): void
```

--------------------------------

### GET /flyToParameters

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.ESCustomPrimitive.html

Retrieves or updates flight-related parameters such as distance, duration, heading, and pitch.

```APIDOC
## GET/SET /flyToParameters

### Description
Manages flight parameters including distance, duration, heading, pitch, and offsets.

### Method
GET, SET

### Endpoint
/flyToDistance, /flyToFlyDuration, /flyToHeading, /flyToPitch, /flyToHDelta, /flyToPDelta

### Parameters
#### Request Body
- **value** (number | undefined) - The value to set for the specific flight parameter

### Response
#### Success Response (200)
- **value** (number | undefined) - The current value of the flight parameter
```

--------------------------------

### Properties and Configuration

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ol.OlGeoCanvasMenuPoi.html

Key properties for configuring the appearance and behavior of the menu point.

```APIDOC
## Properties

- **clickCommandName** (string) - The command name triggered on click.
- **commands** (Array) - List of commands defined as [name, title, description, imageUrl].
- **description** (string) - Description text for the menu point.
- **enabled** (boolean) - Whether the menu point is enabled.
- **imageUri** (string) - URI for the menu point icon.
- **mainPoiBgColor** ([number, number, number, number]) - Background color of the main POI.
- **mainPoiFgColor** ([number, number, number, number]) - Foreground color of the main POI.
- **mainPoiSize** ([number, number]) - Size dimensions of the main POI.
- **position** ([number, number, number]) - 3D coordinates of the POI.
- **show** (boolean) - Visibility state of the POI.
- **title** (string) - Title text for the menu point.
```

--------------------------------

### CzmESPath Class Overview

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESPath.html

Detailed documentation for the CzmESPath class, including its constructor and static registration methods.

```APIDOC
## Constructor

### constructor

#### Description
Creates a new instance of CzmESPath.

#### Parameters
- **sceneObject** (T) - Required - The scene object to associate with the engine object.
- **czmViewer** (ESCesiumViewer) - Required - The viewport to associate with the engine object.

## Static Methods

### register

#### Description
Registers an engine object constructor for non-editing mode to the global context.

#### Parameters
- **viewerType** (string) - Required - The type name of the viewer.
- **sceneObjectTypeName** (string) - Required - The type name of the scene object.
- **objConstructor** (new (sceneObject: R, viewer: V) => EngineObject<R>) - Required - The constructor function for the engine object.

### registerEditing

#### Description
Registers an engine object constructor for editing mode to the global context.

#### Parameters
- **viewerType** (string) - Required - The type name of the viewer.
- **sceneObjectTypeName** (string) - Required - The type name of the scene object.
- **objConstructor** (new (sceneObject: R, viewer: V) => EngineObject<R>) - Required - The constructor function for the engine object.
```

--------------------------------

### CzmESPoi2D Constructor

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESPoi2D.html

Details the constructor for the CzmESPoi2D class, including parameters and usage examples.

```APIDOC
## Constructor

### `constructor`

- `new CzmESPoi2D(sceneObject: ESPoi2D, czmViewer: ESCesiumViewer): CzmESPoi2D`

#### Parameters
* **sceneObject** (ESPoi2D) - The scene object associated with the engine object.
* **czmViewer** (ESCesiumViewer) - The viewer associated with the engine object.

#### Special Usage Restrictions or Potential Side Effects:
* In editing mode, the constructor does not perform initialization.
* The constructor automatically sets the viewport for the scene object and triggers a viewport change event.
* The constructor handles the addition and removal of scene object components, ensuring they are correctly associated with the viewer.

#### Example Usage:
```javascript
// Example of constructing a CzmESPoi2D object
const sceneObject = new ESPoi2D(...);
const czmViewer = new ESCesiumViewer(...);
const poi2D = new CzmESPoi2D(sceneObject, czmViewer);
```
```

--------------------------------

### Static Methods - Registration

Source: https://www.earthsdk.com/docs/classes/earthsdk3-cesium.CzmESExcavate.html

Methods for registering engine object constructors to the global context.

```APIDOC
## register

### Description
Registers a non-editing mode engine object constructor to the global context.

### Parameters
- **viewerType** (string) - Required - The type name of the viewer.
- **sceneObjectTypeName** (string) - Required - The type name of the scene object.
- **objConstructor** (function) - Required - The constructor function for the engine object.

## registerEditing

### Description
Registers an editing mode engine object constructor to the global context.
```

--------------------------------

### Object Area

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESPolygonFlattenedPlane.html

Accessors for getting and setting the area of a geographic object and subscribing to area changes.

```APIDOC
## GET /api/object/area

### Description
Gets the area of the geographic object.

### Method
GET

### Endpoint
/api/object/area

### Response
#### Success Response (200)
- **area** (number) - The calculated area of the object.

## PUT /api/object/area

### Description
Sets the area of the geographic object. Note: This might not be a direct setter but could trigger recalculations or updates based on geometry.

### Method
PUT

### Endpoint
/api/object/area

### Parameters
#### Request Body
- **value** (number) - Required - The value to set for the area.
```

--------------------------------

### Constructor - UeESDataMesh

Source: https://www.earthsdk.com/docs/classes/earthsdk3-ue.UeESDataMesh.html

Initializes a new instance of the UeESDataMesh class.

```APIDOC
## Constructor

### Description
Creates a new UeESDataMesh instance associated with a specific scene object and viewer.

### Method
Constructor

### Parameters
#### Path Parameters
- **sceneObject** (ESDataMesh) - Required - The scene object to associate with the engine object.
- **ueViewer** (ESUeViewer) - Required - The viewer to associate with the engine object.
```

--------------------------------

### Manage Fill Ground State

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESLocalPolygonZ.html

Get or set whether the polygon surface is clamped to the ground.

```typescript
get fillGround(): boolean
set fillGround(value: boolean): void
```

--------------------------------

### Constructor ESUnrealActor

Source: https://www.earthsdk.com/docs/classes/earthsdk3.ESUnrealActor.html

Initializes a new instance of the ESUnrealActor class.

```APIDOC
## constructor

### Description
Creates a new instance of the ESUnrealActor class.

### Method
Constructor

### Parameters
#### Path Parameters
- **id** (string) - Optional - The unique identifier for the object.

### Response
- **ESUnrealActor** - Returns an instance of the ESUnrealActor class.
```
Tokens:
Raw