@belife/belife-bim-air 1.6.1-zy.86.patch.8 → 1.6.1-zy.86.patch.9

package/docs/classes/Longan.LightModel.md

@@ -0,0 +1,988 @@
+[gs-bim-air](../gs-bim-air.md) / [Longan](../modules/Longan.md) / LightModel
+
+# Class: LightModel
+
+[Longan](../modules/Longan.md).LightModel
+
+## Hierarchy
+
+- [`RenderObject`](Longan.RenderObject.md)
+
+  ↳ **`LightModel`**
+
+  ↳↳ [`GISBIMObject`](Longan.GISBIMObject.md)
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Longan.LightModel.md#constructor)
+
+### Properties
+
+- [instanceTypes](Longan.LightModel.md#instancetypes)
+- [modelLoaded](Longan.LightModel.md#modelloaded)
+- [typeName](Longan.LightModel.md#typename)
+
+### Accessors
+
+- [childObjects](Longan.LightModel.md#childobjects)
+- [expanded](Longan.LightModel.md#expanded)
+- [faceColor](Longan.LightModel.md#facecolor)
+- [fitWorldModelLoaded](Longan.LightModel.md#fitworldmodelloaded)
+- [id](Longan.LightModel.md#id)
+- [image](Longan.LightModel.md#image)
+- [modelFile](Longan.LightModel.md#modelfile)
+- [modelId](Longan.LightModel.md#modelid)
+- [modelKey](Longan.LightModel.md#modelkey)
+- [name](Longan.LightModel.md#name)
+- [needSerialization](Longan.LightModel.md#needserialization)
+- [no](Longan.LightModel.md#no)
+- [parent](Longan.LightModel.md#parent)
+- [properties](Longan.LightModel.md#properties)
+- [rotate](Longan.LightModel.md#rotate)
+- [scale](Longan.LightModel.md#scale)
+- [segment](Longan.LightModel.md#segment)
+- [showTreeNode](Longan.LightModel.md#showtreenode)
+- [translate](Longan.LightModel.md#translate)
+- [version](Longan.LightModel.md#version)
+- [visible](Longan.LightModel.md#visible)
+
+### Methods
+
+- [addChildObject](Longan.LightModel.md#addchildobject)
+- [addPropertyComponent](Longan.LightModel.md#addpropertycomponent)
+- [afterDeInstantiate](Longan.LightModel.md#afterdeinstantiate)
+- [afterInstantiate](Longan.LightModel.md#afterinstantiate)
+- [afterRender](Longan.LightModel.md#afterrender)
+- [backup](Longan.LightModel.md#backup)
+- [backupSegment](Longan.LightModel.md#backupsegment)
+- [clearChildObjects](Longan.LightModel.md#clearchildobjects)
+- [clearPropertyComponents](Longan.LightModel.md#clearpropertycomponents)
+- [delete](Longan.LightModel.md#delete)
+- [deserialize](Longan.LightModel.md#deserialize)
+- [dispose](Longan.LightModel.md#dispose)
+- [findPropertyComponent](Longan.LightModel.md#findpropertycomponent)
+- [findPropertyComponents](Longan.LightModel.md#findpropertycomponents)
+- [forEach](Longan.LightModel.md#foreach)
+- [loadModel](Longan.LightModel.md#loadmodel)
+- [remove](Longan.LightModel.md#remove)
+- [removeChildObject](Longan.LightModel.md#removechildobject)
+- [removePropertyComponent](Longan.LightModel.md#removepropertycomponent)
+- [render](Longan.LightModel.md#render)
+- [serialize](Longan.LightModel.md#serialize)
+
+## Constructors
+
+### constructor
+
+• **new LightModel**()
+
+#### Overrides
+
+[RenderObject](Longan.RenderObject.md).[constructor](Longan.RenderObject.md#constructor)
+
+## Properties
+
+### instanceTypes
+
+• **instanceTypes**: [`StringKeyList`](Longan.StringKeyList.md)<[`RenderInstanceObject`](Longan.RenderInstanceObject.md)\>
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[instanceTypes](Longan.RenderObject.md#instancetypes)
+
+___
+
+### modelLoaded
+
+• **modelLoaded**: [`List`](Longan.List.md)<() => `void`\>
+
+___
+
+### typeName
+
+• **typeName**: `string` = `"LightModel"`
+
+#### Overrides
+
+[RenderObject](Longan.RenderObject.md).[typeName](Longan.RenderObject.md#typename)
+
+## Accessors
+
+### childObjects
+
+• `get` **childObjects**(): [`RenderObject`](Longan.RenderObject.md)[]
+
+#### Returns
+
+[`RenderObject`](Longan.RenderObject.md)[]
+
+#### Inherited from
+
+RenderObject.childObjects
+
+___
+
+### expanded
+
+• `get` **expanded**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+RenderObject.expanded
+
+• `set` **expanded**(`expanded`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `expanded` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.expanded
+
+___
+
+### faceColor
+
+• `get` **faceColor**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+• `set` **faceColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number`[] |
+
+#### Returns
+
+`void`
+
+___
+
+### fitWorldModelLoaded
+
+• `get` **fitWorldModelLoaded**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+• `set` **fitWorldModelLoaded**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `boolean` |
+
+#### Returns
+
+`void`
+
+___
+
+### id
+
+• `get` **id**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+RenderObject.id
+
+___
+
+### image
+
+• `get` **image**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+RenderObject.image
+
+• `set` **image**(`image`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `image` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.image
+
+___
+
+### modelFile
+
+• `get` **modelFile**(): `string`
+
+#### Returns
+
+`string`
+
+• `set` **modelFile**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### modelId
+
+• `get` **modelId**(): `string`
+
+#### Returns
+
+`string`
+
+• `set` **modelId**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### modelKey
+
+• `get` **modelKey**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **modelKey**(`modelKey`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `modelKey` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+RenderObject.name
+
+• `set` **name**(`na`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `na` | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.name
+
+___
+
+### needSerialization
+
+• `get` **needSerialization**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+RenderObject.needSerialization
+
+• `set` **needSerialization**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.needSerialization
+
+___
+
+### no
+
+• `get` **no**(): `number`
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+RenderObject.no
+
+___
+
+### parent
+
+• `get` **parent**(): [`RenderObject`](Longan.RenderObject.md)
+
+#### Returns
+
+[`RenderObject`](Longan.RenderObject.md)
+
+#### Inherited from
+
+RenderObject.parent
+
+• `set` **parent**(`parent`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `parent` | [`RenderObject`](Longan.RenderObject.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.parent
+
+___
+
+### properties
+
+• `get` **properties**(): `any`
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+RenderObject.properties
+
+• `set` **properties**(`props`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.properties
+
+___
+
+### rotate
+
+• `get` **rotate**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+• `set` **rotate**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number`[] |
+
+#### Returns
+
+`void`
+
+___
+
+### scale
+
+• `get` **scale**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+• `set` **scale**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number`[] |
+
+#### Returns
+
+`void`
+
+___
+
+### segment
+
+• `get` **segment**(): [`Segment`](Longan.Segment.md)
+
+#### Returns
+
+[`Segment`](Longan.Segment.md)
+
+#### Inherited from
+
+RenderObject.segment
+
+___
+
+### showTreeNode
+
+• `get` **showTreeNode**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+RenderObject.showTreeNode
+
+• `set` **showTreeNode**(`showTreeNode`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `showTreeNode` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.showTreeNode
+
+___
+
+### translate
+
+• `get` **translate**(): `number`[]
+
+#### Returns
+
+`number`[]
+
+• `set` **translate**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number`[] |
+
+#### Returns
+
+`void`
+
+___
+
+### version
+
+• `get` **version**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **version**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### visible
+
+• `get` **visible**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+RenderObject.visible
+
+• `set` **visible**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+RenderObject.visible
+
+## Methods
+
+### addChildObject
+
+▸ **addChildObject**(`ro`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ro` | [`RenderObject`](Longan.RenderObject.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[addChildObject](Longan.RenderObject.md#addchildobject)
+
+___
+
+### addPropertyComponent
+
+▸ **addPropertyComponent**(`component`, `segment?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `component` | [`PropertyComponent`](Longan.PropertyComponent.md) |
+| `segment?` | [`Segment`](Longan.Segment.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[addPropertyComponent](Longan.RenderObject.md#addpropertycomponent)
+
+___
+
+### afterDeInstantiate
+
+▸ **afterDeInstantiate**(`viewer`, `instanceObj`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `viewer` | [`Viewer`](Longan.Viewer.md) |
+| `instanceObj` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[afterDeInstantiate](Longan.RenderObject.md#afterdeinstantiate)
+
+___
+
+### afterInstantiate
+
+▸ **afterInstantiate**(`viewer`, `instanceObj`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `viewer` | [`Viewer`](Longan.Viewer.md) |
+| `instanceObj` | `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[afterInstantiate](Longan.RenderObject.md#afterinstantiate)
+
+___
+
+### afterRender
+
+▸ **afterRender**(`process?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `process?` | [`Process`](Longan.Process.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[afterRender](Longan.RenderObject.md#afterrender)
+
+___
+
+### backup
+
+▸ **backup**(): `Object`
+
+#### Returns
+
+`Object`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[backup](Longan.RenderObject.md#backup)
+
+___
+
+### backupSegment
+
+▸ **backupSegment**(): [`Segment`](Longan.Segment.md)
+
+#### Returns
+
+[`Segment`](Longan.Segment.md)
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[backupSegment](Longan.RenderObject.md#backupsegment)
+
+___
+
+### clearChildObjects
+
+▸ **clearChildObjects**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[clearChildObjects](Longan.RenderObject.md#clearchildobjects)
+
+___
+
+### clearPropertyComponents
+
+▸ **clearPropertyComponents**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[clearPropertyComponents](Longan.RenderObject.md#clearpropertycomponents)
+
+___
+
+### delete
+
+▸ **delete**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[delete](Longan.RenderObject.md#delete)
+
+___
+
+### deserialize
+
+▸ **deserialize**(`obj`, `persistenceManager`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `obj` | `any` |
+| `persistenceManager` | [`PersistenceManager`](Longan.PersistenceManager.md) |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[RenderObject](Longan.RenderObject.md).[deserialize](Longan.RenderObject.md#deserialize)
+
+___
+
+### dispose
+
+▸ **dispose**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[dispose](Longan.RenderObject.md#dispose)
+
+___
+
+### findPropertyComponent
+
+▸ **findPropertyComponent**<`T`\>(`type`, `segment?`): `T`
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `any` |
+| `segment?` | [`Segment`](Longan.Segment.md) |
+
+#### Returns
+
+`T`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[findPropertyComponent](Longan.RenderObject.md#findpropertycomponent)
+
+___
+
+### findPropertyComponents
+
+▸ **findPropertyComponents**<`T`\>(`type`): [`List`](Longan.List.md)<`T`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `type` | `any` |
+
+#### Returns
+
+[`List`](Longan.List.md)<`T`\>
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[findPropertyComponents](Longan.RenderObject.md#findpropertycomponents)
+
+___
+
+### forEach
+
+▸ **forEach**(`callback`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | (`ro`: [`RenderObject`](Longan.RenderObject.md)) => `any` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[forEach](Longan.RenderObject.md#foreach)
+
+___
+
+### loadModel
+
+▸ **loadModel**(`data`, `process?`, ...`args`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `ArrayBuffer` |
+| `process?` | [`Process`](Longan.Process.md) |
+| `...args` | `any`[] |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[loadModel](Longan.RenderObject.md#loadmodel)
+
+___
+
+### remove
+
+▸ **remove**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[remove](Longan.RenderObject.md#remove)
+
+___
+
+### removeChildObject
+
+▸ **removeChildObject**(`ro`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ro` | [`RenderObject`](Longan.RenderObject.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[removeChildObject](Longan.RenderObject.md#removechildobject)
+
+___
+
+### removePropertyComponent
+
+▸ **removePropertyComponent**(`component`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `component` | [`PropertyComponent`](Longan.PropertyComponent.md) |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[removePropertyComponent](Longan.RenderObject.md#removepropertycomponent)
+
+___
+
+### render
+
+▸ **render**(): `void`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[RenderObject](Longan.RenderObject.md).[render](Longan.RenderObject.md#render)
+
+___
+
+### serialize
+
+▸ **serialize**(): `any`
+
+#### Returns
+
+`any`
+
+#### Overrides
+
+[RenderObject](Longan.RenderObject.md).[serialize](Longan.RenderObject.md#serialize)