Class Model

模型组件

Export

Date

2022.3.29

Author

lyx

Hierarchy

Renderable
- Model

Constructors

constructor

new Model(entity, parameters): Model
Parameters
- entity: Entity
- parameters: ModelParameters
Returns Model

Overrides Renderable.constructor

Properties

`Protected` _bounds

_bounds: Box3 = ...

`Protected` _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Protected` _object3D

_object3D: Object3D<Object3DEventMap>

`Protected` _renderOrder

_renderOrder: RenderOrder

`Readonly` isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

userData

userData: {
[key: string]: any;
} = {}

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

bounds

get bounds(): Readonly<Box3>
获取世界外包范围

Returns Readonly<Box3>

Memberof
Renderable

Inherited from Renderable.bounds

color

set color(value): void
设置颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
Model

emissive

set emissive(value): void
设置自发光颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
Model

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Renderable.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Renderable.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Renderable.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Renderable.entity

modelAsset

get modelAsset(): ModelAsset
获取模型资源

Returns ModelAsset

Memberof
Model

object3D

get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
获取渲染组件对应的Object3D（three.js）对象

Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

Memberof
Model

Overrides Renderable.object3D

opacity

set opacity(value): void
设置透明度
Parameters
- value: number
Returns void

Memberof
Model

position

get position(): Vector3
获取本地位置

Returns Vector3

Memberof
Model

Overrides Renderable.position

quaternion

get quaternion(): Quaternion
获取本地旋转四元数

Returns Quaternion

Memberof
Model

Overrides Renderable.quaternion

renderOrder

get renderOrder(): RenderOrder
获取渲染顺序

Returns RenderOrder

Memberof
Renderable

Inherited from Renderable.renderOrder
set renderOrder(value): void
设置渲染顺序
Parameters
- value: RenderOrder
Returns void

Memberof
Renderable

Inherited from Renderable.renderOrder

rotation

get rotation(): Euler
获取本地旋转角（单位：弧度）

Returns Euler

Memberof
Model

Overrides Renderable.rotation

scale

get scale(): Vector3
获取本地缩放

Returns Vector3

Memberof
Model

Overrides Renderable.scale

sharedMaterials

set sharedMaterials(value): void
设置是否共享材质
Parameters
- value: boolean
Returns void

Memberof
Model

subModels

get subModels(): SubModel[]
获取子模型列表

Returns SubModel[]

Memberof
Model

visible

get visible(): boolean
获取是否可见

Returns boolean

Memberof
Model

Overrides Renderable.visible
set visible(value): void
设置是否可见
Parameters
- value: boolean
Returns void

Memberof
Model

Overrides Renderable.visible

worldPosition

get worldPosition(): Vector3
获取世界位置

Returns Vector3

Memberof
Model

Overrides Renderable.worldPosition

worldQuaternion

get worldQuaternion(): Quaternion
获取世界旋转四元数

Returns Quaternion

Memberof
Model

Overrides Renderable.worldQuaternion

worldScale

get worldScale(): Vector3
获取世界缩放

Returns Vector3

Memberof
Model

Overrides Renderable.worldScale

Methods

`Protected` _destroy

_destroy(): void
Protected
销毁接口

Returns void

Memberof
Model

Overrides Renderable._destroy

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from Renderable._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁渲染组件

Returns void

Memberof
Renderable

Inherited from Renderable._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用模型渲染组件

Returns void

Memberof
Model

Overrides Renderable._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用模型渲染组件

Returns void

Memberof
Model

Overrides Renderable._onEnable

`Protected` _updateBounds

_updateBounds(): void
Protected
更新外包盒

Returns void

Memberof
Model

Overrides Renderable._updateBounds

`Protected` _updateMatrixWorld

_updateMatrixWorld(): void
Protected
更新世界矩阵

Returns void

Memberof
Model

Overrides Renderable._updateMatrixWorld

`Protected` _updateRenderOrder

_updateRenderOrder(): void
Protected
更新渲染顺序

Returns void

Memberof
Renderable

Inherited from Renderable._updateRenderOrder

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Renderable.addEventListener

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Renderable.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Renderable.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Renderable.dispose

localToWorld

localToWorld(vector): Vector3
本地坐标转世界坐标
Parameters
- vector: number[] | Vector3
  
  本地坐标
Returns Vector3

Memberof
Model

Overrides Renderable.localToWorld

raycast

raycast(raycaster): Intersection<Object3D<Object3DEventMap>>
射线拾取
Parameters
- raycaster: Raycaster
Returns Intersection<Object3D<Object3DEventMap>>

Memberof
Model

Overrides Renderable.raycast

recoverMaterial

recoverMaterial(): void
恢复原始材质

Returns void

Memberof
Model

Overrides Renderable.recoverMaterial

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Renderable.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Renderable.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Renderable.removeEventListenerByEventId

replaceMaterial

replaceMaterial(material): void
替换材质
Parameters
- material: Material | Material[]
Returns void

Memberof
Model

Overrides Renderable.replaceMaterial

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Renderable.setActive

setClipping

setClipping(parameters?): void
设置裁剪
Parameters
- Optional parameters: ClippingParameters = {}
  
  裁剪参数
Returns void

Memberof
Model

Overrides Renderable.setClipping

setEdge

setEdge(edge, parameters?): void
设置边框效果
Parameters
- edge: boolean
- Optional parameters: EdgeParameters = {}
Returns void

Memberof
Model

setGlow

setGlow(glow, parameters?): void
设置Glow效果
Parameters
- glow: boolean
- Optional parameters: GlowParameters = {}
Returns void

Memberof
Model

setHighlight

setHighlight(highlight, parameters?): void
设置高亮
Parameters
- highlight: boolean
  
  是否高亮
- Optional parameters: HighlightParameters = {}
  
  高亮参数
Returns void

Memberof
Model

Overrides Renderable.setHighlight

setMorphTargetInfluence

setMorphTargetInfluence(target, influence, smoothing?): void
设置变形目标影响值
Parameters
- target: string
  
  变形目标
- influence: number
  
  变形影响值
- Optional smoothing: number = 1
Returns void

Memberof
Model

setStencil

setStencil(parameters?): void
设置模板
Parameters
- Optional parameters: StencilParameters = {}
  
  模板参数
Returns void

Memberof
Model

Overrides Renderable.setStencil

setTransform

setTransform(transformation): void
设置本地方位信息
Parameters
- transformation: Transformation
Returns void

Memberof
Model

Overrides Renderable.setTransform

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Renderable.updateProperties

worldToLocal

worldToLocal(vector): Vector3
世界坐标转本地坐标
Parameters
- vector: number[] | Vector3
  
  世界坐标
Returns Vector3

Memberof
Model

Overrides Renderable.worldToLocal