Piero

Appearance

Documentation / @giro3d/piero / modules / analysis / FloodingPlane

Class: FloodingPlane ​

Defined in: packages/piero/src/modules/analysis/FloodingPlane.ts:10

An analysis module that displays a flooding plane with variable altitude.

Implements ​

Constructors ​

Constructor ​

new FloodingPlane(): FloodingPlane

Returns ​

FloodingPlane

Properties ​

id ​

readonly id: "builtin-analysis-flooding-plane" = 'builtin-analysis-flooding-plane'

Defined in: packages/piero/src/modules/analysis/FloodingPlane.ts:11

The unique id of the module, that also acts as a key to find the module configuration in the app configuration.

Implementation of ​

Module.id

name ​

readonly name: "Flooding plane" = 'Flooding plane'

Defined in: packages/piero/src/modules/analysis/FloodingPlane.ts:12

The readable name of the module.

Implementation of ​

Module.name

Methods ​

initialize() ​

initialize(context): void

Defined in: packages/piero/src/modules/analysis/FloodingPlane.ts:16

Initialize this module on the Piero context.

Parameters ​

context ​

PieroContext

Returns ​

void

Implementation of ​

Module.initialize