Piero

Appearance

Documentation / @giro3d/piero / modules / analysis / ClippingBox

Class: ClippingBox ​

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:17

An analysis module that clips objects from a box.

Implements ​

Constructors ​

Constructor ​

new ClippingBox(): ClippingBox

Returns ​

ClippingBox

Properties ​

id ​

readonly id: "builtin-analysis-clipping-box" = moduleId

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:18

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: "Clipping box" = 'Clipping box'

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:20

The readable name of the module.

Implementation of ​

Module.name

Methods ​

getClippingBox() ​

getClippingBox(): Box3

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:26

Returns ​

Box3

initialize() ​

initialize(context): void

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:33

Initialize this module on the Piero context.

Parameters ​

context ​

PieroContext

Returns ​

void

Implementation of ​

Module.initialize

isClippingBoxEnabled() ​

isClippingBoxEnabled(): boolean

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:54

Returns ​

boolean

isClippingBoxInverted() ​

isClippingBoxInverted(): boolean

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:61

Returns ​

boolean

setClippingBox() ​

setClippingBox(box): void

Defined in: packages/piero/src/modules/analysis/ClippingBox.ts:68

Parameters ​

box ​

Box3

Returns ​

void