Model | 如视 Five SDK - v5.0.0-alpha.106

Five 模型

description: 通过 work 数据加载, 适配 at3d、pbm、dome、domez 格式的文件可以通过 jsonp 解析 base64 的 dataURL 内容，需要满足 your/path/filename.at3d.json_xxxxxx, 通过 json_xxxxxx() 方式返回。

Hierarchy

PBMContainer
- Model

Implements

Subscribe<ModelEventType>

Index

Constructors

constructor

Properties

Accessors

shownfloor

Methods

Constructors

constructor

new Model(options?: { allowHosts?: string[]; networkSubscribe?: NetworkSubscribe }): Model

Overrides PBMContainer.constructor
- Defined in lib/five/loaders/model/index.ts:184
Parameters
- options: { allowHosts?: string[]; networkSubscribe?: NetworkSubscribe } = {}
  - Optional allowHosts?: string[]
  - Optional networkSubscribe?: NetworkSubscribe
Returns Model

Properties

bounding

bounding: Box3

外接盒子的大小

bvhs

bvhs: BVH[] & { loaded: boolean }

bvh 树的计算结果

emit

emit: emit<ModelEventType>

触发事件具体可查看 Subscribe.emit

empty

empty: boolean

是否未加载

floorLength

floorLength: number

楼层的数量

hasListener

hasListener: hasListener<ModelEventType>

判断是否注册了事件具体可查看 Subscribe.hasListener

loaded

loaded: boolean

是否加载完成

needsRender

needsRender: boolean = true

是否需要更新按需渲染

off

off: off<ModelEventType>

解除事件具体可查看 Subscribe.off

on

on: on<ModelEventType>

注册事件具体可查看 Subscribe.on

once

once: once<ModelEventType>

注册事件(是否只执行一次) 具体可查看 Subscribe.once

shownFloor

shownFloor: number

当前显示的楼层

Accessors

shownfloor

get shownfloor(): number

- Defined in lib/five/loaders/model/index.ts:203
当前显示的楼层

deprecated
请用 shwonFloor 代替

Returns number

Methods

buildBVH

buildBVH(): void

- Defined in lib/five/loaders/model/index.ts:397
Returns void

dispose

dispose(): void

- Defined in lib/five/loaders/model/index.ts:520
析构函数

description
一旦析构，则不能使用

Returns void

disposeGeometry

disposeGeometry(): void

Inherited from PBMContainer.disposeGeometry
- Defined in lib/five/core/pbmContainer.ts:91
析构模型网格

Returns void

disposeMaterial

disposeMaterial(): void

Inherited from PBMContainer.disposeMaterial
- Defined in lib/five/core/pbmContainer.ts:67
析构材质

Returns void

getEdges

getEdges(threshold?: number): Line3[]

- Defined in lib/five/loaders/model/index.ts:212
获取模型边界线

Parameters
- threshold: number = ...
  
  面片间夹角阈值
Returns Line3[]
所有模型边界线

getMaterial

getMaterial(): PBMParameters

Inherited from PBMContainer.getMaterial
- Defined in lib/five/core/pbmContainer.ts:30
获取材质参数

Returns PBMParameters

getTransparent

getTransparent(): boolean

Inherited from PBMContainer.getTransparent
- Defined in lib/five/core/pbmContainer.ts:14
获取是否有透明参数

Returns boolean

hasFloors

hasFloors(): number

- Defined in lib/five/loaders/model/index.ts:277
获取当前楼层数

deprecated
请使用 floorLength 参数代替

Returns number

intersectRaycaster

intersectRaycaster(raycaster: Raycaster, floors?: number | number[]): Intersection[]

- Defined in lib/five/loaders/model/index.ts:334
计算模型射线碰撞检测

Parameters
- raycaster: Raycaster
  
  THREE 射线对象
- Optional floors: number | number[]
  
  和某一楼层做碰撞检测，不传为和所有楼层做碰撞检测
Returns Intersection[]
返回碰撞

load

load(workModel: WorkModel, textureOptions?: TextureOptions): Promise<void>

- Defined in lib/five/loaders/model/index.ts:453
加载模型

Parameters
- workModel: WorkModel
  
  work 的 model 内容
- textureOptions: TextureOptions = {}
Returns Promise<void>

setMaterial

setMaterial(parameters: Partial<PBMParameters>): void

Inherited from PBMContainer.setMaterial
- Defined in lib/five/core/pbmContainer.ts:51
设置材质参数

Parameters
- parameters: Partial<PBMParameters>
Returns void

setTransparent

setTransparent(bool: boolean): void

Inherited from PBMContainer.setTransparent
- Defined in lib/five/core/pbmContainer.ts:19
设置透明参数

Parameters
- bool: boolean
Returns void

show

show(): void
show(floorIndex: number, hiddenOpacity?: number): void

显示某楼层

example

model.show() //显示全部楼层
model.show(1) //显示第一楼层
model.show(1, 0) //显示第一楼层, 并且其他楼层透明度为 0

Returns void

- Defined in lib/five/loaders/model/index.ts:300
Parameters
- floorIndex: number
- Optional hiddenOpacity: number
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { allowHosts?: string[]; networkSubscribe?: NetworkSubscribe } = {}

Optional allowHosts?: string[]

Optional networkSubscribe?: NetworkSubscribe

Returns Model

Properties

bounding

bvhs

emit

empty

floorLength

hasListener

loaded

needsRender

off

on

once

shownFloor

Accessors

shownfloor

Returns number

Methods

buildBVH

Returns void

dispose

Returns void

disposeGeometry

Returns void

disposeMaterial

Returns void

getEdges

Parameters

threshold: number = ...

Returns Line3[]

getMaterial

Returns PBMParameters

getTransparent

Returns boolean

hasFloors

Returns number

intersectRaycaster

Parameters

raycaster: Raycaster

Optional floors: number | number[]

Returns Intersection[]

load

Parameters

workModel: WorkModel

textureOptions: TextureOptions = {}

Returns Promise<void>

setMaterial

Parameters

parameters: Partial<PBMParameters>

Returns void

setTransparent

Parameters

bool: boolean

Returns void

show

Returns void

Parameters

floorIndex: number

Optional hiddenOpacity: number

Returns void