start MethodStatic
Start hypermodeling mode for the specified viewport if it is not currently enabled. If hypermodeling is already enabled for the viewport, the existing decorator is returned; otherwise, a new decorator is created.
start(viewport: ScreenViewport): Promise<undefined | HyperModelingDecorator>
@returns The decorator that implements hypermodeling features for the viewport, or undefined if hypermodeling could not be enabled.
@note Enabling hypermodeling may fail if the viewport is not viewing a spatial model or if the viewport's iModel does not support hypermodeling.
| Parameter | Type | Description |
|---|---|---|
| viewport | ScreenViewport | The viewport for which to enable hypermodeling |
Returns - Promise<undefined | HyperModelingDecorator>
The decorator that implements hypermodeling features for the viewport, or undefined if hypermodeling could not be enabled.
Defined in
- hypermodeling/src/HyperModeling.ts Line 240
Last Updated: 16 April, 2024