gs-bim-air 1.6.1-beta.61 → 1.6.1-beta.62

package/docs/classes/Command.CommandShowCaeAxisCut.md

@@ -0,0 +1,944 @@
+[gs-bim-air](../gs-bim-air.md) / [Command](../modules/Command.md) / CommandShowCaeAxisCut
+
+# Class: CommandShowCaeAxisCut
+
+[Command](../modules/Command.md).CommandShowCaeAxisCut
+
+## Hierarchy
+
+- `CommandComponent`
+
+  ↳ **`CommandShowCaeAxisCut`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Command.CommandShowCaeAxisCut.md#constructor)
+
+### Properties
+
+- [\_axis](Command.CommandShowCaeAxisCut.md#_axis)
+- [\_axisDirection](Command.CommandShowCaeAxisCut.md#_axisdirection)
+- [\_bb](Command.CommandShowCaeAxisCut.md#_bb)
+- [\_cuttingPlaneOperator](Command.CommandShowCaeAxisCut.md#_cuttingplaneoperator)
+- [\_viewer](Command.CommandShowCaeAxisCut.md#_viewer)
+- [bag](Command.CommandShowCaeAxisCut.md#bag)
+- [onBegin](Command.CommandShowCaeAxisCut.md#onbegin)
+- [onEnd](Command.CommandShowCaeAxisCut.md#onend)
+- [onInterrupt](Command.CommandShowCaeAxisCut.md#oninterrupt)
+- [onRestore](Command.CommandShowCaeAxisCut.md#onrestore)
+- [typeName](Command.CommandShowCaeAxisCut.md#typename)
+- [nameCounter](Command.CommandShowCaeAxisCut.md#namecounter)
+
+### Accessors
+
+- [Axis](Command.CommandShowCaeAxisCut.md#axis)
+- [axisDirection](Command.CommandShowCaeAxisCut.md#axisdirection)
+- [bindComponent](Command.CommandShowCaeAxisCut.md#bindcomponent)
+- [bindOtherComponent](Command.CommandShowCaeAxisCut.md#bindothercomponent)
+- [commandData](Command.CommandShowCaeAxisCut.md#commanddata)
+- [componentName](Command.CommandShowCaeAxisCut.md#componentname)
+- [currentState](Command.CommandShowCaeAxisCut.md#currentstate)
+- [cuttingPlaneOperator](Command.CommandShowCaeAxisCut.md#cuttingplaneoperator)
+- [disabled](Command.CommandShowCaeAxisCut.md#disabled)
+- [handledCommandPack](Command.CommandShowCaeAxisCut.md#handledcommandpack)
+- [handledCommandState](Command.CommandShowCaeAxisCut.md#handledcommandstate)
+- [handledStateList](Command.CommandShowCaeAxisCut.md#handledstatelist)
+- [isHistoryHandled](Command.CommandShowCaeAxisCut.md#ishistoryhandled)
+- [isSuccessed](Command.CommandShowCaeAxisCut.md#issuccessed)
+- [process](Command.CommandShowCaeAxisCut.md#process)
+- [toggleCallback](Command.CommandShowCaeAxisCut.md#togglecallback)
+- [viewer](Command.CommandShowCaeAxisCut.md#viewer)
+- [visible](Command.CommandShowCaeAxisCut.md#visible)
+
+### Methods
+
+- [begin](Command.CommandShowCaeAxisCut.md#begin)
+- [beginByState](Command.CommandShowCaeAxisCut.md#beginbystate)
+- [buttonsVisible](Command.CommandShowCaeAxisCut.md#buttonsvisible)
+- [cancelHandledHistory](Command.CommandShowCaeAxisCut.md#cancelhandledhistory)
+- [commandCancel](Command.CommandShowCaeAxisCut.md#commandcancel)
+- [commandOk](Command.CommandShowCaeAxisCut.md#commandok)
+- [end](Command.CommandShowCaeAxisCut.md#end)
+- [endByState](Command.CommandShowCaeAxisCut.md#endbystate)
+- [hide](Command.CommandShowCaeAxisCut.md#hide)
+- [hideOther](Command.CommandShowCaeAxisCut.md#hideother)
+- [hideOthers](Command.CommandShowCaeAxisCut.md#hideothers)
+- [interrupt](Command.CommandShowCaeAxisCut.md#interrupt)
+- [interruptByState](Command.CommandShowCaeAxisCut.md#interruptbystate)
+- [name](Command.CommandShowCaeAxisCut.md#name)
+- [restore](Command.CommandShowCaeAxisCut.md#restore)
+- [restoreByState](Command.CommandShowCaeAxisCut.md#restorebystate)
+- [sendMessage](Command.CommandShowCaeAxisCut.md#sendmessage)
+- [show](Command.CommandShowCaeAxisCut.md#show)
+- [showOther](Command.CommandShowCaeAxisCut.md#showother)
+- [toggle](Command.CommandShowCaeAxisCut.md#toggle)
+
+## Constructors
+
+### constructor
+
+• **new CommandShowCaeAxisCut**()
+
+#### Overrides
+
+CommandComponent.constructor
+
+## Properties
+
+### \_axis
+
+• **\_axis**: ``"x"`` \| ``"y"`` \| ``"z"``
+
+___
+
+### \_axisDirection
+
+• **\_axisDirection**: ``1`` \| ``-1``
+
+___
+
+### \_bb
+
+• **\_bb**: `any` = `null`
+
+___
+
+### \_cuttingPlaneOperator
+
+• **\_cuttingPlaneOperator**: `CuttingPlaneOperator` = `null`
+
+___
+
+### \_viewer
+
+• **\_viewer**: [`Viewer`](Viewer.md)
+
+#### Inherited from
+
+CommandComponent.\_viewer
+
+___
+
+### bag
+
+• **bag**: `Object` = `{}`
+
+#### Inherited from
+
+CommandComponent.bag
+
+___
+
+### onBegin
+
+• **onBegin**: [`List`](Longan.List.md)<() => `void`\>
+
+#### Inherited from
+
+CommandComponent.onBegin
+
+___
+
+### onEnd
+
+• **onEnd**: [`List`](Longan.List.md)<() => `void`\>
+
+#### Inherited from
+
+CommandComponent.onEnd
+
+___
+
+### onInterrupt
+
+• **onInterrupt**: [`List`](Longan.List.md)<() => `void`\>
+
+#### Inherited from
+
+CommandComponent.onInterrupt
+
+___
+
+### onRestore
+
+• **onRestore**: [`List`](Longan.List.md)<() => `void`\>
+
+#### Inherited from
+
+CommandComponent.onRestore
+
+___
+
+### typeName
+
+• **typeName**: `string` = `"CommandShowCaeAxisCut"`
+
+#### Overrides
+
+CommandComponent.typeName
+
+___
+
+### nameCounter
+
+▪ `Static` **nameCounter**: `number` = `0`
+
+#### Inherited from
+
+CommandComponent.nameCounter
+
+## Accessors
+
+### Axis
+
+• `get` **Axis**(): ``"x"`` \| ``"y"`` \| ``"z"``
+
+#### Returns
+
+``"x"`` \| ``"y"`` \| ``"z"``
+
+• `set` **Axis**(`axis`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `axis` | ``"x"`` \| ``"y"`` \| ``"z"`` |
+
+#### Returns
+
+`void`
+
+___
+
+### axisDirection
+
+• `get` **axisDirection**(): ``1`` \| ``-1``
+
+#### Returns
+
+``1`` \| ``-1``
+
+• `set` **axisDirection**(`direction`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `direction` | ``1`` \| ``-1`` |
+
+#### Returns
+
+`void`
+
+___
+
+### bindComponent
+
+• `get` **bindComponent**(): () => `void`
+
+#### Returns
+
+`fn`
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.bindComponent
+
+• `set` **bindComponent**(`component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `component` | () => `void` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.bindComponent
+
+___
+
+### bindOtherComponent
+
+• `set` **bindOtherComponent**(`component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `component` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.bindOtherComponent
+
+___
+
+### commandData
+
+• `get` **commandData**(): `any`
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+CommandComponent.commandData
+
+• `set` **commandData**(`data`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.commandData
+
+___
+
+### componentName
+
+• `get` **componentName**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+CommandComponent.componentName
+
+___
+
+### currentState
+
+• `get` **currentState**(): [`DeltaState`](Longan.DeltaState.md)
+
+#### Returns
+
+[`DeltaState`](Longan.DeltaState.md)
+
+#### Inherited from
+
+CommandComponent.currentState
+
+• `set` **currentState**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | [`DeltaState`](Longan.DeltaState.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.currentState
+
+___
+
+### cuttingPlaneOperator
+
+• `get` **cuttingPlaneOperator**(): `CuttingPlaneOperator`
+
+#### Returns
+
+`CuttingPlaneOperator`
+
+___
+
+### disabled
+
+• `get` **disabled**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+CommandComponent.disabled
+
+• `set` **disabled**(`disabled`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `disabled` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.disabled
+
+___
+
+### handledCommandPack
+
+• `get` **handledCommandPack**(): [`StatePack`](Longan.StatePack.md)
+
+#### Returns
+
+[`StatePack`](Longan.StatePack.md)
+
+#### Inherited from
+
+CommandComponent.handledCommandPack
+
+• `set` **handledCommandPack**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | [`StatePack`](Longan.StatePack.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.handledCommandPack
+
+___
+
+### handledCommandState
+
+• `get` **handledCommandState**(): [`DeltaState`](Longan.DeltaState.md)
+
+#### Returns
+
+[`DeltaState`](Longan.DeltaState.md)
+
+#### Inherited from
+
+CommandComponent.handledCommandState
+
+• `set` **handledCommandState**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | [`DeltaState`](Longan.DeltaState.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.handledCommandState
+
+___
+
+### handledStateList
+
+• `get` **handledStateList**(): [`List`](Longan.List.md)<[`DeltaState`](Longan.DeltaState.md)\>
+
+#### Returns
+
+[`List`](Longan.List.md)<[`DeltaState`](Longan.DeltaState.md)\>
+
+#### Inherited from
+
+CommandComponent.handledStateList
+
+___
+
+### isHistoryHandled
+
+• `get` **isHistoryHandled**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+CommandComponent.isHistoryHandled
+
+• `set` **isHistoryHandled**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.isHistoryHandled
+
+___
+
+### isSuccessed
+
+• `get` **isSuccessed**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+CommandComponent.isSuccessed
+
+• `set` **isSuccessed**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.isSuccessed
+
+___
+
+### process
+
+• `get` **process**(): [`Process`](Longan.Process.md)
+
+#### Returns
+
+[`Process`](Longan.Process.md)
+
+#### Inherited from
+
+CommandComponent.process
+
+• `set` **process**(`process`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `process` | [`Process`](Longan.Process.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.process
+
+___
+
+### toggleCallback
+
+• `set` **toggleCallback**(`toggleCallback`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `toggleCallback` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.toggleCallback
+
+___
+
+### viewer
+
+• `get` **viewer**(): [`Viewer`](Viewer.md)
+
+#### Returns
+
+[`Viewer`](Viewer.md)
+
+#### Inherited from
+
+CommandComponent.viewer
+
+• `set` **viewer**(`viewer`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `viewer` | [`Viewer`](Viewer.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.viewer
+
+___
+
+### visible
+
+• `get` **visible**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+CommandComponent.visible
+
+## Methods
+
+### begin
+
+▸ **begin**(): `void`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+CommandComponent.begin
+
+___
+
+### beginByState
+
+▸ **beginByState**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.beginByState
+
+___
+
+### buttonsVisible
+
+▸ **buttonsVisible**(`visible?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `visible?` | `boolean` |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+CommandComponent.buttonsVisible
+
+___
+
+### cancelHandledHistory
+
+▸ **cancelHandledHistory**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.cancelHandledHistory
+
+___
+
+### commandCancel
+
+▸ **commandCancel**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.commandCancel
+
+___
+
+### commandOk
+
+▸ **commandOk**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.commandOk
+
+___
+
+### end
+
+▸ **end**(): `void`
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+CommandComponent.end
+
+___
+
+### endByState
+
+▸ **endByState**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.endByState
+
+___
+
+### hide
+
+▸ **hide**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.hide
+
+___
+
+### hideOther
+
+▸ **hideOther**(`componentName`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `componentName` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.hideOther
+
+___
+
+### hideOthers
+
+▸ **hideOthers**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.hideOthers
+
+___
+
+### interrupt
+
+▸ **interrupt**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.interrupt
+
+___
+
+### interruptByState
+
+▸ **interruptByState**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.interruptByState
+
+___
+
+### name
+
+▸ **name**(`name?`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name?` | `string` |
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+CommandComponent.name
+
+___
+
+### restore
+
+▸ **restore**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.restore
+
+___
+
+### restoreByState
+
+▸ **restoreByState**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.restoreByState
+
+___
+
+### sendMessage
+
+▸ **sendMessage**(`commandMessage`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `commandMessage` | `Object` |
+| `commandMessage.msg` | `string` |
+| `commandMessage.sender` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.sendMessage
+
+___
+
+### show
+
+▸ **show**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.show
+
+___
+
+### showOther
+
+▸ **showOther**(`componentName`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `componentName` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+CommandComponent.showOther
+
+___
+
+### toggle
+
+▸ **toggle**(): `any`
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+CommandComponent.toggle