Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Viewer

视图类

Hierarchy

  • Viewer

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

blockColor

  • set blockColor(color: Color): void

  • 设置默认屏蔽色

    Parameters

    Returns void

camera

  • get camera(): undefined | Camera

  • 获取相机对象

    Returns undefined | Camera

highLightColor

  • set highLightColor(color: Color): void

  • 设置默认高亮色

    Parameters

    Returns void

isUseUE

  • get isUseUE(): boolean

  • isUseUE render

    Returns boolean

isolateColor

  • set isolateColor(color: Color): void

  • 设置默认隔离色

    Parameters

    Returns void

keyboardMode

  • get keyboardMode(): boolean
  • set keyboardMode(enable: boolean): void

  • 是否开启键盘模式

    Returns boolean

  • 是否开启键盘模式

    Parameters

    • enable: boolean

    Returns void

maximumZoomDistance

  • get maximumZoomDistance(): undefined | number
  • set maximumZoomDistance(value: undefined | number): void

  • 最大缩放距离 调用之前需要设置 enableClampZoom

    Returns undefined | number

  • 最大缩放距离,调用之前需要设置 enableClampZoom

    Parameters

    • value: undefined | number

    Returns void

minimumZoomDistance

  • get minimumZoomDistance(): undefined | number
  • set minimumZoomDistance(value: undefined | number): void

  • 最小缩放距离 调用之前需要设置 enableClampZoom

    Returns undefined | number

  • 最小缩放距离 调用之前需要设置 enableClampZoom

    Parameters

    • value: undefined | number

    Returns void

renderEffect

ueErrCode

  • get ueErrCode(): number

  • Returns number

ueErrMsg

  • get ueErrMsg(): string

  • Returns string

Methods

Init

  • Init(): Promise<void>

  • 视图初始化

    Returns Promise<void>

destroy

  • destroy(): void

  • 销毁

    Returns void

disableClampZoom

  • disableClampZoom(): void

  • 关闭视角范围调整

    Returns void

disableNormalFace

  • disableNormalFace(): void

  • 禁用捕捉面

    Returns void

disableSnap

  • disableSnap(): void

  • 禁用捕捉点

    Returns void

enableClampZoom

  • enableClampZoom(): void

  • 开启视角范围调整（调用maximumPitch minimumPitch maximumZoomDistance minimumZoomDistance 之前需要enable此方法）

    Returns void

enableNormalFace

  • enableNormalFace(): void

  • 开启捕捉面

    Returns void

enableSnap

  • enableSnap(): void

  • 开启捕捉点

    Returns void

enableViewCube

  • 是否开启ViewCube

    Parameters

    • enable: boolean

      boolean

    • Optional options: ViewCubeOptions

      ViewCube的样式

    Returns void

exportImage

  • exportImage(name?: string): Promise<string>

  • 截图

    Parameters

    • Optional name: string

      下载的文件名称

    Returns Promise<string>

getFaceNormal

  • getFaceNormal(): undefined | Vector3

  • 获取当前捕捉面法相量

    Returns undefined | Vector3

getSnapPoint

  • getSnapPoint(): undefined | Vector3

  • 获取当前捕捉点

    Returns undefined | Vector3

getSnapPosition

  • getSnapPosition(movement: Vector2): Promise<undefined | void | Vector3>

  • 获取捕捉点三维坐标

    Parameters

    Returns Promise<undefined | void | Vector3>

getViewPosition

  • 获取当前视口参数

    Returns Promise<undefined | ViewPosition>

initUEViewer

  • initUEViewer(projId: string, projType: MODTYPE): Promise<void>

  • init ue viewer

    Parameters

    Returns Promise<void>

isDestroyed

  • isDestroyed(): boolean

  • 是否销毁

    Returns boolean

openModelProject

  • openModelProject(modelId: string, localCacheSearch?: boolean): Promise<undefined | ModelProjectData>

  • 内部接口：此接口用于直接打开模型列表中的模型，除非特殊开通权限，否则禁止调用此接口直接打开模型预览，正确的方式参照案例工程中打开工程的方式

    Parameters

    • modelId: string

      模型列表中的模型ID

    • localCacheSearch: boolean = true

    Returns Promise<undefined | ModelProjectData>

    模型工程和对应的场景工程

pick

  • 拾取模型对象

    Parameters

    • windowPosition: Vector2

      屏幕坐标点

    Returns undefined | PickObject

pickAdaptor

  • 拾取模型对象，异步，同时兼容 UE 和 WebGL 的 pick

    Parameters

    • windowPosition: Vector2

      屏幕坐标点

    Returns Promise<undefined | PickObject>

pickPosition

  • 拾取点

    Parameters

    • windowPosition: Vector2

      屏幕坐标点

    Returns Promise<undefined | Vector3>

pickPositionAryByRayForPhysical

  • pickPositionAryByRayForPhysical(startPt: Vector3, direction: Vector3, ptAryRet: Vector3[]): Promise<void>

  • 射线求交，获取交点集合（注：如果需要使用线段求交的话，可有遍历ptAry中的点，判断其和startPt的距离， 如果小于线段长度，有效，如果大于无效过滤）

    Parameters

    Returns Promise<void>

queryProject

  • queryProject(): Promise<Project[]>
  • queryProject(projectId: string): Promise<undefined | Project>
  • queryProject(projectIds: string[]): Promise<Project[]>

  • 获取工程的详情

    Returns Promise<Project[]>

    工程的详情

  • Parameters

    • projectId: string

    Returns Promise<undefined | Project>

  • Parameters

    • projectIds: string[]

    Returns Promise<Project[]>

setLightDir

  • setLightDir(heading: number, pitch: number, roll: number): void

  • 设置光源的方向（角度）

    Parameters

    • heading: number

      朝向角度：正北为0°

    • pitch: number

      俯仰角：向下为负

    • roll: number

      旋转角：相机方向顺时针为正

    Returns void

setPanRotateApplyType

  • 设置默认鼠标操控方式（缩放默认中建不修改） 移动端不支持MIDDLE_MOUSE_BIN

    Parameters

    Returns void

setRotateOnlyHorizontal

  • setRotateOnlyHorizontal(enable: boolean): void

  • 设置仅在水平面旋转

    Parameters

    • enable: boolean

      平移

    Returns void

wgs84ToWindowCoordinates

  • wgs84ToWindowCoordinates(position: Vector3): Cartesian2

  • 三维坐标转当前对应的屏幕坐标

    Parameters

    • position: Vector3

      MotorCore.Vector3

    Returns Cartesian2