capacitor-scenehelper

2-way connection with 3D scenes

Install

npm install capacitor-scenehelper
npx cap sync

API

• startScene(...)
• camera(...)
• node(...)
• setBlockingAreas(...)
• createGeometryHeightmap(...)
• Interfaces

startScene(...)

startScene(options: StartSceneOptions) => Promise<GeneralStatus>

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | StartSceneOptions |

Returns: Promise<GeneralStatus>

camera(...)

camera(options: GeneralCommands) => Promise<GeneralCommandResponse>

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | GeneralCommands |

Returns: Promise<GeneralCommandResponse>

node(...)

node(options: GeneralCommands) => Promise<GeneralCommandResponse>

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | GeneralCommands |

Returns: Promise<GeneralCommandResponse>

setBlockingAreas(...)

setBlockingAreas(options: BlockingAreaOptions) => Promise<GeneralStatus>

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | BlockingAreaOptions |

Returns: Promise<GeneralStatus>

createGeometryHeightmap(...)

createGeometryHeightmap(options: HeightMapOptions) => Promise<GeneralCommandResponse>

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | HeightMapOptions |

Returns: Promise<GeneralCommandResponse>

Interfaces

GeneralStatus

| Prop | Type | | ------------- | -------------------- | | success | boolean | | error | any |

StartSceneOptions

| Prop | Type | | -------------------- | -------------------- | | container | any | | toBack | boolean | | imageRendering | boolean | | value | string |

GeneralCommandResponse

| Prop | Type | | ------------- | -------------------- | | success | boolean | | error | any | | context | any |

GeneralCommands

| Prop | Type | | -------------- | ------------------ | | commands | [any] | | context | any |

BlockingAreaOptions

| Prop | Type | | ----------- | ------------------ | | areas | [any] |

HeightMapOptions

| Prop | Type | | --------------- | ------------------- | | url | any | | id | string | | mapSize | any | | scale | any | | worldSize | any |