Class Model

Five 模型

Description

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

Hierarchy

Object3D
- Model

Constructors

constructor

new Model(
work: Work,
options?: { light?: boolean; textureOptions?: TextureOptions },
): Model
Parameters
- work: Work
- options: { light?: boolean; textureOptions?: TextureOptions } = {}
Returns Model
- Defined in lib/five/model/model.ts:92

Properties

add

add: (...object: ViewLayer[]) => this

Adds object as child of this object.

autoRefine

autoRefine: boolean = true

是否自动细化

boundingBox

boundingBox: Box3 = ...

外接盒子的大小

children

children: ViewLayer[]

Array with object's children.

floorLength

floorLength: number

所有楼层

initReady

initReady: Promise<void>

初始化完成

loaded

loaded: boolean = false

模型已经加载

loadedReady

loadedReady: Promise<void>

初次加载完成

metaPending

metaPending: boolean = false

是否在加载元信息

needsRender

needsRender: boolean

outdated

outdated: boolean = false

是否过期

parameter

parameter: Parameter = ...

parent

parent: ModelScene

Object's parent in the scene graph.

refined

refined: boolean = false

模型是否已经细化

refineProgress

refineProgress: [number, number] = ...

模型细化进度

work

work: Work

work

Accessors

bounding

get bounding(): Box3
Returns Box3
Deprecated
Use .boundingBox instead
- Defined in lib/five/model/model.ts:336

brightness

get brightness(): number
Returns number
Deprecated
Use .parameter.brightness .parameter.set('brightness', brightness) instead
- Defined in lib/five/model/model.ts:379
set brightness(brightness: number): void
Parameters
- brightness: number
Returns void
- Defined in lib/five/model/model.ts:386

clippers

get clippers(): readonly PBMClipperParameter[]
Returns readonly PBMClipperParameter[]
Deprecated
Use .parameter.clippers .parameter.set('clippers', clippers) instead
- Defined in lib/five/model/model.ts:394
set clippers(clippers: readonly PBMClipperParameter[]): void
Parameters
- clippers: readonly PBMClipperParameter[]
Returns void
- Defined in lib/five/model/model.ts:401

customShaders

get customShaders(): readonly PBMCustomShader[]
Returns readonly PBMCustomShader[]
Deprecated
Use .parameter.customShaders .parameter.set('customShaders', customShaders) instead
- Defined in lib/five/model/model.ts:409
set customShaders(customShaders: readonly PBMCustomShader[]): void
Parameters
- customShaders: readonly PBMCustomShader[]
Returns void
- Defined in lib/five/model/model.ts:416

empty

get empty(): boolean
模型内容是否为空

Returns boolean
- Defined in lib/five/model/model.ts:163

shownFloor

get shownFloor(): number
当前显示的楼层

Returns number
- Defined in lib/five/model/model.ts:310
set shownFloor(floor: number): void
Parameters
- floor: number
Returns void
- Defined in lib/five/model/model.ts:313

shownFloorIndex

get shownFloorIndex(): number
Returns number
Deprecated
Use .parameter.shownFloorIndex .parameter.set('brightness', brightness) instead
- Defined in lib/five/model/model.ts:364
set shownFloorIndex(floorIndex: number): void
Parameters
- floorIndex: number
Returns void
- Defined in lib/five/model/model.ts:371

viewLayers

get viewLayers(): ViewLayer[]
模型的不同图层

Returns ViewLayer[]
- Defined in lib/five/model/model.ts:168

Methods

addEventListener

addEventListener(
type: "error",
listener: (event: Event & { error: Error; type: "error" }) => void,
): void
Parameters
- type: "error"
- listener: (event: Event & { error: Error; type: "error" }) => void
Returns void
- Defined in lib/five/model/model.ts:27
addEventListener(
type: "load",
listener: (event: Event & { type: "load" }) => void,
): void
Parameters
- type: "load"
- listener: (event: Event & { type: "load" }) => void
Returns void
- Defined in lib/five/model/model.ts:28
addEventListener(
type: "dispose",
listener: (event: Event & { type: "dispose" }) => void,
): void
Parameters
- type: "dispose"
- listener: (event: Event & { type: "dispose" }) => void
Returns void
- Defined in lib/five/model/model.ts:29
addEventListener(
    type: "changeShownFloor",
    listener: (
        event: Event & { floorIndex: number; type: "changeShownFloor" },
    ) => void,
): void
Parameters
- type: "changeShownFloor"
- listener: (event: Event & { floorIndex: number; type: "changeShownFloor" }) => void
Returns void
- Defined in lib/five/model/model.ts:30
addEventListener(type: string, listener: (event: Event) => void): void
Parameters
- type: string
- listener: (event: Event) => void
Returns void
- Defined in lib/five/model/model.ts:31

dispatchEvent

dispatchEvent(event: { error: Error; type: "error" }): void
Parameters
- event: { error: Error; type: "error" }
Returns void
- Defined in lib/five/model/model.ts:21
dispatchEvent(event: { type: "load" }): void
Parameters
- event: { type: "load" }
Returns void
- Defined in lib/five/model/model.ts:22
dispatchEvent(event: { type: "dispose" }): void
Parameters
- event: { type: "dispose" }
Returns void
- Defined in lib/five/model/model.ts:23
dispatchEvent(event: { floorIndex: number; type: "shownFloorChange" }): void
Parameters
- event: { floorIndex: number; type: "shownFloorChange" }
Returns void
- Defined in lib/five/model/model.ts:24
dispatchEvent(event: { type: string; [attachment: string]: any }): void
Parameters
- event: { type: string; [attachment: string]: any }
Returns void
- Defined in lib/five/model/model.ts:25

dispose

dispose(): void
析构函数一旦析构，则不能使用

Returns void
- Defined in lib/five/model/model.ts:150

enuToLocal

enuToLocal(vector: Vector3): Vector3
Parameters
- vector: Vector3
Returns Vector3
- Defined in lib/five/model/model.ts:294

enuToWorld

enuToWorld(vector: Vector3): Vector3
Parameters
- vector: Vector3
Returns Vector3
- Defined in lib/five/model/model.ts:302

getEdgesBySphere

getEdgesBySphere(sphere: Sphere, threshold?: number): Line3[]
获取模型边界线
Parameters
- sphere: Sphere
  获取区域
- threshold: number = ...
  面片间夹角阈值
Returns Line3[]
所有模型边界线
- Defined in lib/five/model/model.ts:178

getMaterial

getMaterial(): ParameterValue
Returns ParameterValue
Deprecated
Use .parameter.get instead
- Defined in lib/five/model/model.ts:352

intersectRaycaster

intersectRaycaster(
raycaster: Raycaster,
target?: Intersection[],
): Intersection[]
计算模型射线碰撞检测
Parameters
- raycaster: Raycaster
  THREE 射线对象
- Optionaltarget: Intersection[]
  返回碰撞
Returns Intersection[]
返回碰撞
- Defined in lib/five/model/model.ts:188

localToEnu

localToEnu(vector: Vector3): Vector3
Parameters
- vector: Vector3
Returns Vector3
- Defined in lib/five/model/model.ts:290

removeEventListener

removeEventListener(
type: "error",
listener: (event: Event & { error: Error; type: "error" }) => void,
): void
Parameters
- type: "error"
- listener: (event: Event & { error: Error; type: "error" }) => void
Returns void
- Defined in lib/five/model/model.ts:33
removeEventListener(
type: "load",
listener: (event: Event & { type: "load" }) => void,
): void
Parameters
- type: "load"
- listener: (event: Event & { type: "load" }) => void
Returns void
- Defined in lib/five/model/model.ts:34
removeEventListener(
type: "dispose",
listener: (event: Event & { type: "dispose" }) => void,
): void
Parameters
- type: "dispose"
- listener: (event: Event & { type: "dispose" }) => void
Returns void
- Defined in lib/five/model/model.ts:35
removeEventListener(
    type: "changeShownFloor",
    listener: (
        event: Event & { floorIndex: number; type: "changeShownFloor" },
    ) => void,
): void
Parameters
- type: "changeShownFloor"
- listener: (event: Event & { floorIndex: number; type: "changeShownFloor" }) => void
Returns void
- Defined in lib/five/model/model.ts:36
removeEventListener(type: string, listener: (event: Event) => void): void
Parameters
- type: string
- listener: (event: Event) => void
Returns void
- Defined in lib/five/model/model.ts:37

resetBrightness

resetBrightness(): void
Returns void
Deprecated
Use .parameter.reset('brightness') instead
- Defined in lib/five/model/model.ts:424

setMaterial

setMaterial(parameter: Partial<ParameterValue>): void
Parameters
- parameter: Partial<ParameterValue>
Returns void
Deprecated
Use .parameter.set instead
- Defined in lib/five/model/model.ts:344

show

show(floor?: number): void
显示某楼层
Parameters
- Optionalfloor: number
Returns void
Example
```
model.show() //显示全部楼层
model.show(1) //显示第一楼层
```
- Defined in lib/five/model/model.ts:325

update

update(renderer: WebGLRenderer, camera: Camera, modelScene: ModelScene): boolean
Parameters
- renderer: WebGLRenderer
- camera: Camera
- modelScene: ModelScene
Returns boolean
- Defined in lib/five/model/model.ts:206

worldToEnu

worldToEnu(vector: Vector3): Vector3
Parameters
- vector: Vector3
Returns Vector3
- Defined in lib/five/model/model.ts:298

Class Model

Description

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Model

Properties

add

autoRefine

boundingBox

children

floorLength

initReady

loaded

loadedReady

metaPending

needsRender

outdated

parameter

parent

refined

refineProgress

work

Accessors

bounding

Returns Box3

Deprecated

brightness

Returns number

Deprecated

Parameters

Returns void

clippers

Returns readonly PBMClipperParameter[]

Deprecated

Parameters

Returns void

customShaders

Returns readonly PBMCustomShader[]

Deprecated

Parameters

Returns void

empty

Returns boolean

shownFloor

Returns number

Parameters

Returns void

shownFloorIndex

Returns number

Deprecated

Parameters

Returns void

viewLayers

Returns ViewLayer[]

Methods

addEventListener

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

dispatchEvent

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void