@belife/belife-bim-air 1.6.1-zy.86.patch.6 → 1.6.1-zy.86.patch.7

package/docs/classes/Command.CommandShowFirstPersonRoam.md

@@ -1,1176 +0,0 @@
-[gs-bim-air](../gs-bim-air.md) / [Command](../modules/Command.md) / CommandShowFirstPersonRoam
-
-# Class: CommandShowFirstPersonRoam
-
-[Command](../modules/Command.md).CommandShowFirstPersonRoam
-
-## Hierarchy
-
-- `CommandComponent`
-
-  ↳ **`CommandShowFirstPersonRoam`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](Command.CommandShowFirstPersonRoam.md#constructor)
-
-### Properties
-
-- [\_distance](Command.CommandShowFirstPersonRoam.md#_distance)
-- [\_isCutting](Command.CommandShowFirstPersonRoam.md#_iscutting)
-- [\_viewer](Command.CommandShowFirstPersonRoam.md#_viewer)
-- [bag](Command.CommandShowFirstPersonRoam.md#bag)
-- [cuttingObjects](Command.CommandShowFirstPersonRoam.md#cuttingobjects)
-- [cuttingPlane](Command.CommandShowFirstPersonRoam.md#cuttingplane)
-- [cuttingPlaneSegment](Command.CommandShowFirstPersonRoam.md#cuttingplanesegment)
-- [firstPersonOperator](Command.CommandShowFirstPersonRoam.md#firstpersonoperator)
-- [isCuttingVisible](Command.CommandShowFirstPersonRoam.md#iscuttingvisible)
-- [locateFlag](Command.CommandShowFirstPersonRoam.md#locateflag)
-- [onBegin](Command.CommandShowFirstPersonRoam.md#onbegin)
-- [onEnd](Command.CommandShowFirstPersonRoam.md#onend)
-- [onInterrupt](Command.CommandShowFirstPersonRoam.md#oninterrupt)
-- [onRestore](Command.CommandShowFirstPersonRoam.md#onrestore)
-- [planePoints](Command.CommandShowFirstPersonRoam.md#planepoints)
-- [recordDynamicMemoryType](Command.CommandShowFirstPersonRoam.md#recorddynamicmemorytype)
-- [typeName](Command.CommandShowFirstPersonRoam.md#typename)
-- [updateSectionEvent](Command.CommandShowFirstPersonRoam.md#updatesectionevent)
-- [nameCounter](Command.CommandShowFirstPersonRoam.md#namecounter)
-
-### Accessors
-
-- [bindComponent](Command.CommandShowFirstPersonRoam.md#bindcomponent)
-- [bindOtherComponent](Command.CommandShowFirstPersonRoam.md#bindothercomponent)
-- [commandData](Command.CommandShowFirstPersonRoam.md#commanddata)
-- [componentName](Command.CommandShowFirstPersonRoam.md#componentname)
-- [currentState](Command.CommandShowFirstPersonRoam.md#currentstate)
-- [disabled](Command.CommandShowFirstPersonRoam.md#disabled)
-- [distance](Command.CommandShowFirstPersonRoam.md#distance)
-- [handledCommandPack](Command.CommandShowFirstPersonRoam.md#handledcommandpack)
-- [handledCommandState](Command.CommandShowFirstPersonRoam.md#handledcommandstate)
-- [handledStateList](Command.CommandShowFirstPersonRoam.md#handledstatelist)
-- [isCollision](Command.CommandShowFirstPersonRoam.md#iscollision)
-- [isCutting](Command.CommandShowFirstPersonRoam.md#iscutting)
-- [isGravity](Command.CommandShowFirstPersonRoam.md#isgravity)
-- [isHistoryHandled](Command.CommandShowFirstPersonRoam.md#ishistoryhandled)
-- [isSuccessed](Command.CommandShowFirstPersonRoam.md#issuccessed)
-- [process](Command.CommandShowFirstPersonRoam.md#process)
-- [speed](Command.CommandShowFirstPersonRoam.md#speed)
-- [toggleCallback](Command.CommandShowFirstPersonRoam.md#togglecallback)
-- [viewer](Command.CommandShowFirstPersonRoam.md#viewer)
-- [visible](Command.CommandShowFirstPersonRoam.md#visible)
-
-### Methods
-
-- [begin](Command.CommandShowFirstPersonRoam.md#begin)
-- [beginByState](Command.CommandShowFirstPersonRoam.md#beginbystate)
-- [buttonsVisible](Command.CommandShowFirstPersonRoam.md#buttonsvisible)
-- [cancelHandledHistory](Command.CommandShowFirstPersonRoam.md#cancelhandledhistory)
-- [clearCutting](Command.CommandShowFirstPersonRoam.md#clearcutting)
-- [commandCancel](Command.CommandShowFirstPersonRoam.md#commandcancel)
-- [commandOk](Command.CommandShowFirstPersonRoam.md#commandok)
-- [cullingInit](Command.CommandShowFirstPersonRoam.md#cullinginit)
-- [drawBB](Command.CommandShowFirstPersonRoam.md#drawbb)
-- [drawCuttingPlane](Command.CommandShowFirstPersonRoam.md#drawcuttingplane)
-- [end](Command.CommandShowFirstPersonRoam.md#end)
-- [endByState](Command.CommandShowFirstPersonRoam.md#endbystate)
-- [getCutPlanePosition](Command.CommandShowFirstPersonRoam.md#getcutplaneposition)
-- [getPlanePoints](Command.CommandShowFirstPersonRoam.md#getplanepoints)
-- [hide](Command.CommandShowFirstPersonRoam.md#hide)
-- [hideOther](Command.CommandShowFirstPersonRoam.md#hideother)
-- [hideOthers](Command.CommandShowFirstPersonRoam.md#hideothers)
-- [interrupt](Command.CommandShowFirstPersonRoam.md#interrupt)
-- [interruptByState](Command.CommandShowFirstPersonRoam.md#interruptbystate)
-- [isComponent](Command.CommandShowFirstPersonRoam.md#iscomponent)
-- [name](Command.CommandShowFirstPersonRoam.md#name)
-- [restore](Command.CommandShowFirstPersonRoam.md#restore)
-- [restoreByState](Command.CommandShowFirstPersonRoam.md#restorebystate)
-- [sendMessage](Command.CommandShowFirstPersonRoam.md#sendmessage)
-- [show](Command.CommandShowFirstPersonRoam.md#show)
-- [showOther](Command.CommandShowFirstPersonRoam.md#showother)
-- [toggle](Command.CommandShowFirstPersonRoam.md#toggle)
-
-## Constructors
-
-### constructor
-
-• **new CommandShowFirstPersonRoam**()
-
-#### Overrides
-
-CommandComponent.constructor
-
-## Properties
-
-### \_distance
-
-• **\_distance**: `number` = `null`
-
-___
-
-### \_isCutting
-
-• **\_isCutting**: `boolean` = `false`
-
-___
-
-### \_viewer
-
-• **\_viewer**: [`Viewer`](Viewer.md)
-
-#### Inherited from
-
-CommandComponent.\_viewer
-
-___
-
-### bag
-
-• **bag**: `Object` = `{}`
-
-#### Inherited from
-
-CommandComponent.bag
-
-___
-
-### cuttingObjects
-
-• **cuttingObjects**: `CuttingObjects` = `null`
-
-___
-
-### cuttingPlane
-
-• **cuttingPlane**: `CuttingPlaneObject` = `null`
-
-___
-
-### cuttingPlaneSegment
-
-• **cuttingPlaneSegment**: [`Segment`](Longan.Segment.md) = `null`
-
-___
-
-### firstPersonOperator
-
-• **firstPersonOperator**: `FreeRoamOperator`
-
-___
-
-### isCuttingVisible
-
-• **isCuttingVisible**: `boolean` = `false`
-
-___
-
-### locateFlag
-
-• **locateFlag**: `boolean` = `true`
-
-___
-
-### 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
-
-___
-
-### planePoints
-
-• **planePoints**: `Float32Array` = `null`
-
-___
-
-### recordDynamicMemoryType
-
-• **recordDynamicMemoryType**: `number` = `0`
-
-___
-
-### typeName
-
-• **typeName**: `string` = `"CommandShowFirstPersonRoam"`
-
-#### Overrides
-
-CommandComponent.typeName
-
-___
-
-### updateSectionEvent
-
-• **updateSectionEvent**: `any` = `null`
-
-___
-
-### nameCounter
-
-▪ `Static` **nameCounter**: `number` = `0`
-
-#### Inherited from
-
-CommandComponent.nameCounter
-
-## Accessors
-
-### 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
-
-___
-
-### 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
-
-___
-
-### distance
-
-• `get` **distance**(): `number`
-
-获取剖切距离
-
-#### Returns
-
-`number`
-
-• `set` **distance**(`val`): `void`
-
-设置剖切距离
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `val` | `number` |
-
-#### Returns
-
-`void`
-
-___
-
-### 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
-
-___
-
-### isCollision
-
-• `get` **isCollision**(): `boolean`
-
-获取障碍状态
-
-#### Returns
-
-`boolean`
-
-• `set` **isCollision**(`val`): `void`
-
-设置障碍状态
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `val` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### isCutting
-
-• `get` **isCutting**(): `boolean`
-
-获取剖切状态
-
-#### Returns
-
-`boolean`
-
-• `set` **isCutting**(`val`): `void`
-
-设置剖切状态
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `val` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### isGravity
-
-• `get` **isGravity**(): `boolean`
-
-获取重力状态
-
-#### Returns
-
-`boolean`
-
-• `set` **isGravity**(`val`): `void`
-
-设置重力状态
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `val` | `boolean` |
-
-#### Returns
-
-`void`
-
-___
-
-### 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
-
-___
-
-### speed
-
-• `get` **speed**(): `number`
-
-获取漫游速度
-
-#### Returns
-
-`number`
-
-• `set` **speed**(`val`): `void`
-
-设置漫游速度
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `val` | `number` |
-
-#### Returns
-
-`void`
-
-___
-
-### 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
-
-___
-
-### clearCutting
-
-▸ **clearCutting**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### commandCancel
-
-▸ **commandCancel**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-CommandComponent.commandCancel
-
-___
-
-### commandOk
-
-▸ **commandOk**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-CommandComponent.commandOk
-
-___
-
-### cullingInit
-
-▸ **cullingInit**(): `void`
-
-初始化剖面
-
-#### Returns
-
-`void`
-
-___
-
-### drawBB
-
-▸ **drawBB**(`segment`): `void`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `segment` | [`Segment`](Longan.Segment.md) |
-
-#### Returns
-
-`void`
-
-___
-
-### drawCuttingPlane
-
-▸ **drawCuttingPlane**(): `void`
-
-#### Returns
-
-`void`
-
-___
-
-### end
-
-▸ **end**(): `void`
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-CommandComponent.end
-
-___
-
-### endByState
-
-▸ **endByState**(): `void`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-CommandComponent.endByState
-
-___
-
-### getCutPlanePosition
-
-▸ **getCutPlanePosition**(`pos`, `vector`): `Float32Array`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `pos` | `Float32Array` |
-| `vector` | `Float32Array` |
-
-#### Returns
-
-`Float32Array`
-
-___
-
-### getPlanePoints
-
-▸ **getPlanePoints**(`position`, `vector`): `Float32Array`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `position` | `Float32Array` |
-| `vector` | `Float32Array` |
-
-#### Returns
-
-`Float32Array`
-
-___
-
-### 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
-
-___
-
-### isComponent
-
-▸ **isComponent**(`segment`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `segment` | [`Segment`](Longan.Segment.md) |
-
-#### Returns
-
-`boolean`
-
-___
-
-### 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