M3D / M3D / Camera

Class: Camera

M3D.Camera

Memberof

M3D

Implements

M3D.Utility.Publisher

Description

相机

Hierarchy

• M3DObject

  ↳ Camera

Implements

• Publisher

Table of contents

Constructors

• constructor

Properties

• id
• DEFAULT_CAMERA_MAX_ZOOM
• DEFAULT_CAMERA_MIN_ZOOM
• EAxisName
• count

Methods

• getAspectRatio
• getChangeRotation
• getDefaultZoom
• getDirection
• getEffectiveWorldTransform
• getEvents
• getFarClip
• getFitClip
• getFocalLength
• getFov
• getFrustum
• getGridDis
• getHalfClip
• getHalfViewSize
• getId
• getLocalTransform
• getNearClip
• getOrigRotateCenter
• getOrthoSize
• getPlcMatrix
• getPosition
• getProjectionMatrix
• getProjectionMatrixTransposed
• getProjectionOffset
• getRotateCenter
• getRotation
• getRotationQuaternion
• getScreenRay
• getTransform
• getUpDir
• getViewMatrix
• getViewMatrixTransposed
• getViewport
• getWorldPosition
• getWorldRotation
• getZoom
• initCamera
• isOrthographic
• lookAt
• markDirty
• post
• registerEvent
• removeEvent
• resetCamera
• rotateAround
• rotateAroundCenter
• screenToWorldPoint
• send
• setAspectRatio
• setAspectRatioInternal
• setFarClip
• setFocalLength
• setFov
• setGridDis
• setId
• setInitRotateCenter
• setNearClip
• setOrthoSize
• setOrthographic
• setPosition
• setProjectionOffset
• setRotate
• setRotateCenter
• setRotation
• setTransform
• setUpDir
• setViewport
• setWorldDirection
• setWorldPosition
• setWorldRotation
• setWorldScale
• setZoom
• setZoomLimit
• translate
• update
• updateCamera
• updateWorldTransform
• worldToScreenPoint
• zoomView

Constructors

constructor

• new Camera(): Camera

Returns

Camera

Description

构造方法

Overrides

M3DObject.constructor

Properties

id

• id: number

Inherited from

M3DObject.id

---

DEFAULT_CAMERA_MAX_ZOOM

▪ Static DEFAULT_CAMERA_MAX_ZOOM: number

---

DEFAULT_CAMERA_MIN_ZOOM

▪ Static DEFAULT_CAMERA_MIN_ZOOM: number

---

EAxisName

▪ Static EAxisName: Object

Type declaration

Name	Type
MX	number
MY	number
MZ	number
X	number
Y	number
Z	number

---

count

▪ Static count: number

Inherited from

M3DObject.count

Methods

getAspectRatio

▸ getAspectRatio(): number

Returns

number

Description

获取长宽比

---

getChangeRotation

▸ getChangeRotation(): Matrix4

Returns

Matrix4

Description

获取旋转矩阵

---

getDefaultZoom

▸ getDefaultZoom(): number

Returns

number

Description

获取默认缩放比例

---

getDirection

▸ getDirection(): Vector3

Returns

Vector3

Description

获取方向

---

getEffectiveWorldTransform

▸ getEffectiveWorldTransform(): Matrix3x4

Returns

Matrix3x4

Description

获取平移、旋转变换矩阵（不含缩放）

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

M3DObject.getEvents

---

getFarClip

▸ getFarClip(): number

Returns

number

Description

获取远平面

---

getFitClip

▸ getFitClip(): number

Returns

number

Description

获取最佳裁剪面

---

getFocalLength

▸ getFocalLength(): number

Returns

number

Description

获取焦距数据，只有视图用到了

---

getFov

▸ getFov(): number

Returns

number

Description

获取相机视角

---

getFrustum

▸ getFrustum(): Frustum

Returns

Frustum

Description

获取视锥

---

getGridDis

▸ getGridDis(): number

Returns

number

Description

获取网格距离

---

getHalfClip

▸ getHalfClip(): number

Returns

number

Description

获取半裁剪面

---

getHalfViewSize

▸ getHalfViewSize(): number

Returns

number

Description

获取正交模式视图统一大小的一半

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

M3DObject.getId

---

getLocalTransform

▸ getLocalTransform(): Matrix3x4

Returns

Matrix3x4

Description

获取变换矩阵

---

getNearClip

▸ getNearClip(): number

Returns

number

Description

获取近平面

---

getOrigRotateCenter

▸ getOrigRotateCenter(): Vector3

Returns

Vector3

初始旋转中心

Description

获取原始旋转中心

---

getOrthoSize

▸ getOrthoSize(): number

Returns

number

Description

获取正交视图的统一大小

▸ getOrthoSize(orthoSize): any

Parameters

Name	Type
orthoSize	Vector2

Returns

any

Description

获取正交视图的统一大小

---

getPlcMatrix

▸ getPlcMatrix(): Matrix3x4

Returns

Matrix3x4

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取相机位置

---

getProjectionMatrix

▸ getProjectionMatrix(apiSpecific?): Matrix4

Parameters

Name	Type
apiSpecific?	boolean

Returns

Matrix4

Description

获取相机投影矩阵

---

getProjectionMatrixTransposed

▸ getProjectionMatrixTransposed(apiSpecific?): Matrix4

Parameters

Name	Type
apiSpecific?	boolean

Returns

Matrix4

Description

获取相机投影矩阵的转置

---

getProjectionOffset

▸ getProjectionOffset(): Vector2

Returns

Vector2

Description

获取投影偏移

---

getRotateCenter

▸ getRotateCenter(): Vector3

Returns

Vector3

旋转中心

Description

获取旋转中心

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取旋转四元数

---

getRotationQuaternion

▸ getRotationQuaternion(): Quaternion

Returns

Quaternion

Description

获取旋转四元数

---

getScreenRay

▸ getScreenRay(x, y): Ray

Parameters

Name	Type
x	number
y	number

Returns

Ray

Description

获取射线对应屏幕（归一化）坐标

---

getTransform

▸ getTransform(): Matrix3x4

Returns

Matrix3x4

变换矩阵

Description

获取变换矩阵

---

getUpDir

▸ getUpDir(): Vector3

Returns

Vector3

Description

获取向上方向

---

getViewMatrix

▸ getViewMatrix(): Matrix4

Returns

Matrix4

Description

获取相机视图矩阵

---

getViewMatrixTransposed

▸ getViewMatrixTransposed(): Matrix4

Returns

Matrix4

Description

获取视口矩阵的转置

---

getViewport

▸ getViewport(): Viewport

Returns

Viewport

Description

获取相机对应视口

---

getWorldPosition

▸ getWorldPosition(): Vector3

Returns

Vector3

Description

获取相机在世界坐标位置

---

getWorldRotation

▸ getWorldRotation(): Quaternion

Returns

Quaternion

Description

获取相机在世界坐标旋转

---

getZoom

▸ getZoom(): number

Returns

number

Description

获取变焦

---

initCamera

▸ initCamera(boundingBox, viewportRect, showISOMETRIC?): void

Parameters

Name	Type	Description
boundingBox	BoundingBox	包围盒
viewportRect	Rect	画布
showISOMETRIC?	boolean	是否为轴测视图

Returns

void

Description

初始化相机

---

isOrthographic

▸ isOrthographic(): boolean

Returns

boolean

Description

相机是否为正交相机

---

lookAt

▸ lookAt(target, up, space): boolean

Parameters

Name	Type	Description
target	Vector3	三维点
up	Vector3	三维点
space	number	空间

Returns

boolean

Description

相机浏览

---

markDirty

▸ markDirty(): void

Returns

void

Description

dirty标记

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Implementation of

Publisher.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

M3DObject.registerEvent

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

M3DObject.removeEvent

---

resetCamera

▸ resetCamera(): void

Returns

void

Description

复位相机

---

rotateAround

▸ rotateAround(rotCenter, rotDelta, space): void

Parameters

Name	Type
rotCenter	Vector3
rotDelta	Quaternion
space	number

Returns

void

Description

绕中心旋转

---

rotateAroundCenter

▸ rotateAroundCenter(delta, space): void

Parameters

Name	Type
delta	Quaternion
space	number

Returns

void

Description

绕中心旋转变换

---

screenToWorldPoint

▸ screenToWorldPoint(screenPos): Vector3

Parameters

Name	Type
screenPos	Vector2

Returns

Vector3

Description

屏幕坐标转换到世界坐标

▸ screenToWorldPoint(screenPos): Vector3

Parameters

Name	Type
screenPos	Vector3

Returns

Vector3

Description

屏幕坐标转换到世界坐标

▸ screenToWorldPoint(screenPos, depthPosition): Vector3

Parameters

Name	Type
screenPos	Vector2
depthPosition	Vector3

Returns

Vector3

Description

屏幕坐标转换到世界坐标

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Implementation of

Publisher.send

---

setAspectRatio

▸ setAspectRatio(aspectRatio): void

Parameters

Name	Type
aspectRatio	number

Returns

void

Description

手动设置长宽比。禁用自动宽高比模式。

---

setAspectRatioInternal

▸ setAspectRatioInternal(aspectRatio): void

Parameters

Name	Type
aspectRatio	number

Returns

void

Description

设置长宽比

---

setFarClip

▸ setFarClip(far): void

Parameters

Name	Type
far	number

Returns

void

Description

设置远平面

---

setFocalLength

▸ setFocalLength(focalLength): void

Parameters

Name	Type
focalLength	number

Returns

void

Description

更新焦距数据，只有视图用到了

---

setFov

▸ setFov(fov): void

Parameters

Name	Type
fov	number

Returns

void

Description

设置相机视角

---

setGridDis

▸ setGridDis(dis): void

Parameters

Name	Type
dis	number

Returns

void

Description

设置网格距离

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

M3DObject.setId

---

setInitRotateCenter

▸ setInitRotateCenter(center): void

Parameters

Name	Type	Description
center	Vector3	初始旋转中心

Returns

void

Description

设置初始旋转中心

---

setNearClip

▸ setNearClip(near): void

Parameters

Name	Type
near	number

Returns

void

Description

设置近平面

---

setOrthoSize

▸ setOrthoSize(orthoSize): void

Parameters

Name	Type
orthoSize	number

Returns

void

Description

设置正交模式视图的统一大小

▸ setOrthoSize(orthoSize): void

Parameters

Name	Type
orthoSize	Vector2

Returns

void

Description

设置正交模式视图的统一大小

---

setOrthographic

▸ setOrthographic(orthographic): void

Parameters

Name	Type
orthographic	boolean

Returns

void

Description

设置相机是否是正交投影

---

setPosition

▸ setPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置相机位置

---

setProjectionOffset

▸ setProjectionOffset(offset): void

Parameters

Name	Type
offset	Vector2

Returns

void

Description

设置投影偏移

---

setRotate

▸ setRotate(x, y, z): any

Parameters

Name	Type	Description
x	number	x轴的旋转角度
y	number	y轴的旋转角度
z	number	z轴的旋转角度

Returns

any

Description

相机旋转

▸ setRotate(rotateQua): any

Parameters

Name	Type	Description
rotateQua	Quaternion	旋转四元数

Returns

any

Description

相机旋转

---

setRotateCenter

▸ setRotateCenter(center): void

Parameters

Name	Type	Description
center	Vector3	旋转中心

Returns

void

Description

设置旋转中心

---

setRotation

▸ setRotation(rotation): void

Parameters

Name	Type
rotation	Quaternion

Returns

void

Description

设置旋转四元数

---

setTransform

▸ setTransform(position, rotation): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion

Returns

any

Description

设置变换矩阵

▸ setTransform(position, rotation, scale): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion
scale	number

Returns

any

Description

设置变换矩阵

▸ setTransform(position, rotation, scale): any

Parameters

Name	Type
position	Vector3
rotation	Quaternion
scale	Vector3

Returns

any

Description

设置变换矩阵

---

setUpDir

▸ setUpDir(dir): void

Parameters

Name	Type
dir	Vector3

Returns

void

Description

设置向上方向

---

setViewport

▸ setViewport(v): void

Parameters

Name	Type
v	Viewport

Returns

void

Description

设置相机对应视口

---

setWorldDirection

▸ setWorldDirection(scale): void

Parameters

Name	Type
scale	Vector3

Returns

void

Description

设置方向

---

setWorldPosition

▸ setWorldPosition(pos): void

Parameters

Name	Type
pos	Vector3

Returns

void

Description

设置相机在世界坐标位置

---

setWorldRotation

▸ setWorldRotation(rotation): void

Parameters

Name	Type
rotation	Quaternion

Returns

void

Description

设置相机在世界坐标旋转

---

setWorldScale

▸ setWorldScale(scale): void

Parameters

Name	Type
scale	Vector3

Returns

void

Description

设置缩放

---

setZoom

▸ setZoom(zoom): void

Parameters

Name	Type
zoom	number

Returns

void

Description

设置变焦

---

setZoomLimit

▸ setZoomLimit(minZoom, maxZoom): void

Parameters

Name	Type
minZoom	number
maxZoom	number

Returns

void

Description

设置变焦范围

---

translate

▸ translate(delta, space): void

Parameters

Name	Type
delta	Vector3
space	number

Returns

void

Description

设置相机平移

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

---

updateCamera

▸ updateCamera(): void

Returns

void

Description

更新相机参数

---

updateWorldTransform

▸ updateWorldTransform(): void

Returns

void

Description

更新相机在世界坐标下的变换

---

worldToScreenPoint

▸ worldToScreenPoint(worldPos): Vector2

Parameters

Name	Type	Description
worldPos	Vector3	世界坐标位置

Returns

Vector2

Description

世界坐标转换为屏幕坐标

---

zoomView

▸ zoomView(scaleFactor): void

Parameters

Name	Type
scaleFactor	number

Returns

void

Description

缩放视图