Class Engine

引擎

Export

Date

2022.3.19

Author

lyx

Hierarchy

Engine

Index

Constructors

constructor

new Engine(parameters?): Engine
Parameters
- parameters: EngineParameters = {}
Returns Engine

Accessors

analyseManager

get analyseManager(): AnalyseManager
获取分析管理器

Returns AnalyseManager

Memberof
Engine

atlasManager

get atlasManager(): Readonly<AtlasManager>
获取图集管理器

Returns Readonly<AtlasManager>

Memberof
Engine

commandManager

get commandManager(): Readonly<CommandManager>
获取命令管理器

Returns Readonly<CommandManager>

Memberof
Engine

componentManager

get componentManager(): Readonly<ComponentManager>
获取组件管理器

Returns Readonly<ComponentManager>

Memberof
Engine

crsManager

get crsManager(): CRSManager
获取坐标系管理器

Returns CRSManager

Memberof
Engine

eventDispatcher

get eventDispatcher(): Readonly<EventDispatcher>
获取事件分发器

Returns Readonly<EventDispatcher>

Memberof
Engine

fps

set fps(value): void
设置帧率
Parameters
- value: number
Returns void

Memberof
Engine

geologicalManager

get geologicalManager(): Readonly<GeologicalManager>
获取地质管理器

Returns Readonly<GeologicalManager>

Memberof
Engine

materialManager

get materialManager(): Readonly<MaterialManager>
获取材质管理器

Returns Readonly<MaterialManager>

Memberof
Engine

mineManager

get mineManager(): Readonly<MineManager>
获取煤矿对象管理器

Returns Readonly<MineManager>

Memberof
Engine

modelManager

get modelManager(): Readonly<ModelManager>
获取模型管理器

Returns Readonly<ModelManager>

Memberof
Engine

physicsManager

get physicsManager(): Readonly<PhysicsManager>
获取物理管理器

Returns Readonly<PhysicsManager>

Memberof
Engine

query

get query(): Readonly<Query>
获取查询器

Returns Readonly<Query>

Memberof
Engine

sceneRenderer

get sceneRenderer(): Readonly<SceneRenderer>
获取场景渲染器

Returns Readonly<SceneRenderer>

Memberof
Engine

toolManager

get toolManager(): Readonly<ToolManager>
获取工具管理器

Returns Readonly<ToolManager>

Memberof
Engine

uniformsGroup

get uniformsGroup(): UniformsGroup
获取通用Uniforms

Returns UniformsGroup

Memberof
Engine

Methods

addEventListener

addEventListener(event, callback, parameters?): number
添加事件监听器
Parameters
- event: string
  
  事件名称
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  }
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
Engine

createCamera

createCamera(parameters?): Entity
创建一个相机实体
Parameters
- Optional parameters: EntityParameters = {}
  
  相机初始化参数
Returns Entity

Memberof
Engine

createEntity

createEntity(parameters?): Entity
创建一个空实体
Parameters
- Optional parameters: EntityParameters = {}
  
  实体初始化参数
Returns Entity

Memberof
Engine

createExtrudePolygon

createExtrudePolygon(parameters, parent?): Entity
创建矢量块
Parameters
- parameters: ExtrudePolygonParameters
  
  矢量块初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createFault

createFault(parameters, parent?): Entity
创建断层
Parameters
- parameters: CreateFaultParameters
  
  断层构建参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createMeshLine

createMeshLine(parameters, parent?): Entity
创建Mesh线
Parameters
- parameters: MeshLineParameters
  
  MeshLine初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createMinefield

createMinefield(parameters, parent?): Entity
创建井田边界实体
Parameters
- parameters: MinefieldParameters
  
  井田边界初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createOrRetriveRectangleCollision

createOrRetriveRectangleCollision(key): RectangleCollision
创建或检索屏幕空间碰撞器
Parameters
- key: any
Returns RectangleCollision

Memberof
Engine

createPixelLine

createPixelLine(parameters, parent?): Entity
创建像素线
Parameters
- parameters: PixelLineParameters
  
  像素线初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createPoints

createPoints(parameters, parent?): Entity
创建矢量点
Parameters
- parameters: PointsParameters
  
  矢量点初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Deprecated

Memberof
Engine

createPolygon

createPolygon(parameters, parent?): Entity
创建矢量面
Parameters
- parameters: PolygonParameters
  
  矢量面初始化参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity

Memberof
Engine

createPostprocessing

createPostprocessing<T, B>(type, scene, camera, parameters?): T
创建后期处理对象
Type Parameters
- T extends PostprocessingBase
- B extends PostprocessingBaseParameters
Parameters
- type: PostprocessingCtor<T, B>
  
  后期类型
- scene: Entity
  
  关联的场景实体
- camera: Entity
  
  关联的相机实体
- Optional parameters: B
  
  初始化参数
Returns T

Memberof
Engine

createScene

createScene(parameters?): Entity
创建一个场景实体
Parameters
- Optional parameters: SceneParameters = {}
  
  场景初始化参数，默认{}
Returns Entity

Memberof
Engine

createViewpoint

createViewpoint(name?, snapshotWidth?, snapshotHeight?): Viewpoint
创建视点
Parameters
- Optional name: string = ''
  
  视点名称，默认''
- Optional snapshotWidth: number = 512
  
  视点快照宽度，默认512
- Optional snapshotHeight: number = 512
  
  视点快照高度，默认512
Returns Viewpoint

Memberof
Engine

createWatermark

createWatermark(text, parameters?): Entity
创建一个水印实体
Parameters
- text: string
  
  水印内容
- Optional parameters: any
  
  其它参数，可选
Returns Entity

Memberof
Engine

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: any
  
  事件参数
Returns void

Memberof
Engine

dispose

dispose(disposeSharedAssets?): void
释放引擎
Parameters
- Optional disposeSharedAssets: boolean = true
  
  是否释放共享资源，默认true
Returns void

Memberof
Engine

getEntity

getEntity(guid, onlyActiveScene?): Entity
获取指定GUID实体
Parameters
- guid: string
  
  实体GUID
- Optional onlyActiveScene: boolean = true
  
  是否仅查询当前激活的场景，默认true
Returns Entity

Memberof
Engine

getModule

getModule<T>(type): T
获取指定功能模块
Type Parameters
- T extends EngineObject
Parameters
- type: (new (engine, parameters) => T)
  - - new (engine, parameters): T
    - Parameters
      
      engine: Engine
      
      parameters: any
      
      Returns T
Returns T

Memberof
Engine

getPostprocessing

getPostprocessing(guid): PostprocessingBase
获取指定GUID后期对象
Parameters
- guid: string
  
  后期处理对象GUID，为其关联的场景&关联的相机GUID的组合（scene.guid_camera.guid）
Returns PostprocessingBase

Memberof
Engine

goto

goto(viewpoint): void
视点定位
Parameters
- viewpoint: Viewpoint | Viewpoint[]
  
  视点或视点数组
Returns void

Memberof
Engine

isPointProjectedToAnyLaneway

isPointProjectedToAnyLaneway(worldPosition): {
    endIndex: number;
    lanewayCode: string;
    position: Vector3;
    startIndex: number;
}
判断世界坐标点是否可以投影到任意一条巷道的中线上
Parameters
- worldPosition: number[] | Vector3
  
  世界坐标
Returns {
    endIndex: number;
    lanewayCode: string;
    position: Vector3;
    startIndex: number;
}
- endIndex: number
- lanewayCode: string
- position: Vector3
- startIndex: number
Memberof
Engine

loadCollapseColumns

loadCollapseColumns(url, parent?, onProgress?): Promise<Entity[]>
加载陷落柱
Parameters
- url: string
  
  陷落柱数据地址
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<Entity[]>

Memberof
Engine

loadCollapseColumnsByData

loadCollapseColumnsByData(data, parent?): Entity[]
通过数据加载陷落柱
Parameters
- data: any
  
  陷落柱数据
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity[]

Memberof
Engine

loadDrills

loadDrills(url, configuration?, parent?, onProgress?): Promise<Entity[]>
加载钻孔
Parameters
- url: string
  
  钻孔数据地址
- Optional configuration: DrillConfiguration
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<Entity[]>

Memberof
Engine

loadDrillsByData

loadDrillsByData(data, configuration?, parent?): Entity[]
通过数据加载钻孔
Parameters
- data: any
  
  钻孔数据
- Optional configuration: DrillConfiguration
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity[]

Memberof
Engine

loadFBX

loadFBX(url, parameters?, onProgress?): Promise<Entity>
加载FBX模型
Parameters
- url: string
  
  模型url地址
- Optional parameters: ModelEntityParameters = {}
  
  模型实体参数，默认{}
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<Entity>

Memberof
Engine

loadFaults

loadFaults(url, parent?, onProgress?): Promise<Entity[]>
加载断层
Parameters
- url: string
  
  断层数据地址
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<Entity[]>

Memberof
Engine

loadFaultsByData

loadFaultsByData(data, parent?): Entity[]
通过数据加载断层
Parameters
- data: any
  
  断层数据
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity[]

Memberof
Engine

loadGLTF

loadGLTF(url, parameters?, onProgress?): Promise<Entity>
加载GLTF模型
Parameters
- url: string
  
  模型url地址
- Optional parameters: ModelEntityParameters = {}
  
  模型实体参数，默认{}
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<Entity>

Memberof
Engine

loadLaneways

loadLaneways(url, configuration?, parent?, onProgress?): Promise<{
    bounds: Box3;
    crossings: Entity[];
    laneways: Entity[];
}>
加载巷道
Parameters
- url: string
  
  巷道数url地址
- Optional configuration: LanewayConfiguration = {}
  
  巷道配置参数，默认{}
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<{
    bounds: Box3;
    crossings: Entity[];
    laneways: Entity[];
}>

Memberof
Engine

loadLanewaysByData

loadLanewaysByData(data, configuration?, parent?): {
    bounds: Box3;
    crossings: Entity[];
    laneways: Entity[];
}
通过数据加载巷道
Parameters
- data: any
  
  巷道数据
- Optional configuration: LanewayConfiguration = {}
  
  巷道配置参数，默认{}
- Optional parent: Transform
  
  父实体Transform，可选
Returns {
    bounds: Box3;
    crossings: Entity[];
    laneways: Entity[];
}
- bounds: Box3
- crossings: Entity[]
- laneways: Entity[]
Memberof
Engine

loadModelInMine

loadModelInMine(url, parameters, parent?): Promise<Entity>
加载井下模型（仅支持gltf模型）
Parameters
- url: string
  
  模型url地址
- parameters: ModelInMineParameters
  
  模型实体参数
- Optional parent: Transform
  
  父实体Transform，可选
Returns Promise<Entity>

Memberof
Engine

loadModelScene

loadModelScene(url, parent?, onProgress?): Promise<Entity[]>
加载GLTF模型场景
Parameters
- url: string
  
  模型场景Url地址
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<Entity[]>

Memberof
Engine

loadOBJ

loadOBJ(objUrl, mtlUrl, parameters?, onProgress?): Promise<Entity>
加载OBJ模型
Parameters
- objUrl: string
  
  模型obj数据url地址
- mtlUrl: string
  
  模型mtl数据url地址
- Optional parameters: ModelEntityParameters = {}
  
  模型实体参数，默认{}
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<Entity>

Memberof
Engine

loadPipelines

loadPipelines(url, configuration?, parent?, onProgress?): Promise<{
    bounds: Box3;
    joins: Entity[];
    pipelines: Entity[];
}>
加载管线
Parameters
- url: string
  
  管线数据地址
- Optional configuration: PipelineConfiguration
  
  配置参数，默认{}
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<{
    bounds: Box3;
    joins: Entity[];
    pipelines: Entity[];
}>

Memberof
Engine

loadPipelinesByData

loadPipelinesByData(data, configuration, parent?): Promise<{
    bounds: Box3;
    joins: Entity[];
    pipelines: Entity[];
}>
通过数据加载管线
Parameters
- data: any
  
  管线数据
- configuration: PipelineConfiguration
  
  配置参数，默认{}
- Optional parent: Transform
  
  父实体Transform，可选
Returns Promise<{
    bounds: Box3;
    joins: Entity[];
    pipelines: Entity[];
}>
{Promise<{ joins: Array, pipelines: Array, bounds: Box3}>}

Memberof
Engine

loadStratums

loadStratums(url, parent?, onProgress?): Promise<Entity[]>
加载地层
Parameters
- url: string
  
  地层数据url地址
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns Promise<Entity[]>

Memberof
Engine

loadStratumsByData

loadStratumsByData(data, parent?): Entity[]
通过数据加载地层
Parameters
- data: any
  
  地层数据
- Optional parent: Transform
  
  父实体Transform，可选
Returns Entity[]

Memberof
Engine

loadWorkfaces

loadWorkfaces(url, configuration?, parent?, onProgress?): Promise<{
goaf: Entity;
workface: Entity;
}[]>
加载工作面和采空区
Parameters
- url: string
  
  工作面数据url地址
- Optional configuration: {
  goaf?: CoalSeamConfiguration;
  workface?: CoalSeamConfiguration;
  } = {}
  
  配置参数，默认{}
  - Optional goaf?: CoalSeamConfiguration
  - Optional workface?: CoalSeamConfiguration
- Optional parent: Transform
  
  父实体Transform，可选
- Optional onProgress: ((event) => void)
  
  progress回调，可选
  - - (event): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<{
goaf: Entity;
workface: Entity;
}[]>

Memberof
Engine

loadWorkfacesByData

loadWorkfacesByData(data, configuration?, parent?): {
goaf: Entity;
workface: Entity;
}[]
通过数据加载工作面和采空区
Parameters
- data: any
  
  工作面数据
- Optional configuration: {
  goaf?: CoalSeamConfiguration;
  workface?: CoalSeamConfiguration;
  } = {}
  
  配置参数，默认{}
  - Optional goaf?: CoalSeamConfiguration
  - Optional workface?: CoalSeamConfiguration
- Optional parent: Transform
  
  父实体Transform，可选
Returns {
goaf: Entity;
workface: Entity;
}[]

Memberof
Engine

locateEntity

locateEntity(entity, parameters?): void
定位实体
Parameters
- entity: Entity
  
  实体对象
- Optional parameters: LocateParameters = {}
  
  定位参数，默认{}
Returns void

Memberof
Engine

locateEntityByGUID

locateEntityByGUID(guid, parameters?): void
通过GUID定位实体
Parameters
- guid: string
  
  实体GUID
- Optional parameters: LocateParameters = {}
  
  定位参数，默认{}
Returns void

Memberof
Engine

locateIntoLaneway

locateIntoLaneway(lanewayCode, point): void
定位到巷道内部
Parameters
- lanewayCode: string
  
  巷道编码
- point: number[] | Vector3
  
  点坐标（世界坐标）
Returns void

Memberof
Engine

locatePoint

locatePoint(point, parameters?): void
定位到指定点
Parameters
- point: number[] | Vector3
  
  点坐标
- Optional parameters: LocateParameters = {}
  
  定位参数，默认{}
Returns void

Memberof
Engine

projectGeodeticCoordToAnyLaneway

projectGeodeticCoordToAnyLaneway(position, location?, height?): {
    endIndex: number;
    lanewayCode: string;
    position: Vector3;
    quaternion: Quaternion;
    startIndex: number;
}
将地测坐标投影到任意一条巷道上
Parameters
- position: number[] | Vector3
  
  地测坐标
- Optional location: string = 'bottom'
  
  投影位置，可选'bottom'、'left'、'right'、'top'，默认'bottom'
- Optional height: number = 0.0
  
  距离底部高度，默认0.0
Returns {
    endIndex: number;
    lanewayCode: string;
    position: Vector3;
    quaternion: Quaternion;
    startIndex: number;
}
- endIndex: number
- lanewayCode: string
- position: Vector3
- quaternion: Quaternion
- startIndex: number
Memberof
Engine

projectGeodeticCoordToLaneway

projectGeodeticCoordToLaneway(position, lanewayCode): {
position: Vector3;
quaternion: Quaternion;
}
将地测坐标投影到指定巷道上
Parameters
- position: number[] | Vector3
  
  地测坐标
- lanewayCode: string
  
  巷道编码
Returns {
position: Vector3;
quaternion: Quaternion;
}
- position: Vector3
- quaternion: Quaternion
Memberof
Engine

registerModule

registerModule<T>(type, parameters?): T
注册功能模块
Type Parameters
- T extends EngineObject
Parameters
- type: (new (engine, parameters) => T)
  - - new (engine, parameters): T
    - Parameters
      
      engine: Engine
      
      parameters: any
      
      Returns T
- Optional parameters: any
Returns T

Memberof
Engine

removeCamera

removeCamera(camera): void
移除一个相机实体
Parameters
- camera: Entity
  
  相机实体
Returns void

Memberof
Engine

removeEventListener

removeEventListener(event, callback?): void
移除事件监听器
Parameters
- event: string
  
  事件名称
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: any
      
      Returns void
Returns void

Memberof
Engine

removeEventListenerByEventId

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

Memberof
Engine

removePostprocessing

removePostprocessing(guid): void
移除并销毁指定GUID后期对象
Parameters
- guid: string
  
  后期处理对象GUID，为其关联的场景&关联的相机GUID的组合（scene.guid_camera.guid）
Returns void

Memberof
Engine

removeScene

removeScene(scene): void
移除一个场景实体
Parameters
- scene: Entity
  
  场景实体
Returns void

Memberof
Engine

resize

resize(): void
手动调整渲染窗口尺寸

Returns void

Memberof
Engine

setActiveCamera

setActiveCamera(camera): void
设置激活的相机
Parameters
- camera: Entity
  
  相机实体
Returns void

Memberof
Engine

setActiveScene

setActiveScene(scene): void
设置激活的场景
Parameters
- scene: Entity
  
  场景实体
Returns void

Memberof
Engine

transition

transition(targetScene, targetCamera, options?): void
场景转场
Parameters
- targetScene: Entity
  
  目标场景
- targetCamera: Entity
  
  目标相机
- Optional options: TransitionOptions
  
  转场选项
Returns void

Memberof
Engine

unregisterModule

unregisterModule<T>(type): void
注销指定类型功能模块
Type Parameters
- T extends EngineObject
Parameters
- type: (new (engine, parameters) => T)
  - - new (engine, parameters): T
    - Parameters
      
      engine: Engine
      
      parameters: any
      
      Returns T
Returns void

Memberof
Engine

Class Engine

Export

Date

Author

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

parameters: EngineParameters = {}

Returns Engine

Accessors

analyseManager

Returns AnalyseManager

Memberof

atlasManager

Returns Readonly<AtlasManager>

Memberof

commandManager

Returns Readonly<CommandManager>

Memberof

componentManager

Returns Readonly<ComponentManager>

Memberof

crsManager

Returns CRSManager

Memberof

eventDispatcher

Returns Readonly<EventDispatcher>

Memberof

fps

Parameters

value: number

Returns void

Memberof

geologicalManager

Returns Readonly<GeologicalManager>

Memberof

materialManager

Returns Readonly<MaterialManager>

Memberof

mineManager

Returns Readonly<MineManager>

Memberof

modelManager

Returns Readonly<ModelManager>

Memberof

physicsManager

Returns Readonly<PhysicsManager>

Memberof

query

Returns Readonly<Query>

Memberof

sceneRenderer

Returns Readonly<SceneRenderer>

Memberof

toolManager

Returns Readonly<ToolManager>

Memberof

uniformsGroup

Returns UniformsGroup

Memberof

Methods

addEventListener

Parameters

event: string

callback: ((event) => void)

Parameters

event: any

Returns void

Optional parameters: { priority?: Priority; target?: any; }

Optional priority?: Priority

Optional target?: any

Returns number

Memberof

createCamera

Parameters

`Optional` parameters: {
priority?: Priority;
target?: any;
}

`Optional` priority?: Priority

`Optional` target?: any

`Optional` parameters: EntityParameters = {}

`Optional` parameters: EntityParameters = {}

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parent: Transform

`Optional` parameters: B

`Optional` parameters: SceneParameters = {}