Camera

Ploy3D / Camera

Class: Camera

相机组件。

Hierarchy

• Resource<Camera>

  ↳ Camera

Table of contents

Constructors

• constructor

Accessors

• cfg
• cfv
• classid
• culling
• cullingFilter
• depth
• distance
• farZ
• flags
• fov
• gfc
• gfv
• gfw
• guid
• height
• instanceID
• internalPtr
• label
• lastcfw
• nearZ
• package
• pitch
• position
• ptrObject
• readTS
• reprojection
• roll
• skyLuminance
• skyPitch
• skyRoll
• skySH
• skyYaw
• state
• sunColorIntensity
• sunDirection
• target
• updated
• uvfv
• vfc
• vfg
• wdirection
• wfg
• width
• wposition
• writeTS
• yaw

Methods

• Clear
• FixContent
• Init
• Move
• Rotate
• Scale
• ScreenPointToRay

Constructors

constructor

• new Camera(id)

构造函数。

Parameters

Name	Type	Description
id	number	资源实例ID。

Overrides

Resource.constructor

Accessors

cfg

• get cfg(): Float32Array

变换矩阵：全局->裁剪。

Returns

Float32Array

---

cfv

• get cfv(): Float32Array

变换矩阵：相机->裁剪。

Returns

Float32Array

---

classid

• get classid(): ClassID

实例类型ID。

Returns

ClassID

Inherited from

Resource.classid

---

culling

• get culling(): Float32Array

变换矩阵：世界->裁剪（CPU端使用）。

Returns

Float32Array

---

cullingFilter

• get cullingFilter(): number

裁剪过滤，被标记的层不会被视锥裁剪。

Returns

number

• set cullingFilter(value): void

Parameters

Name	Type
value	number

Returns

void

---

depth

• get depth(): number

相机渲染排序。

Returns

number

• set depth(value): void

Parameters

Name	Type
value	number

Returns

void

---

distance

• get distance(): number

距观察目标距离。

Returns

number

• set distance(value): void

Parameters

Name	Type
value	number

Returns

void

---

farZ

• get farZ(): number

远平面距离（理论上作为相机参数，但因为读取前必然应用，所以也可以读取作为着色器应用值）。

Returns

number

• set farZ(value): void

Parameters

Name	Type
value	number

Returns

void

---

flags

• get flags(): number

相机标志集：1-相机参数更新，2-天空球参数更新，4-是否翻转Z值。

Returns

number

• set flags(value): void

Parameters

Name	Type
value	number

Returns

void

---

fov

• get fov(): number

垂直视角（弧度）。

Returns

number

• set fov(value): void

Parameters

Name	Type
value	number

Returns

void

---

gfc

• get gfc(): Float32Array

变换矩阵：裁剪->全局。

Returns

Float32Array

---

gfv

• get gfv(): Float32Array

变换矩阵：相机->全局。

Returns

Float32Array

---

gfw

• get gfw(): Float32Array

变换矩阵：世界->全局。

Returns

Float32Array

---

guid

• get guid(): string

资源全球唯一ID。

Returns

string

Inherited from

Resource.guid

---

height

• get height(): number

画布高度。

Returns

number

• set height(value): void

Parameters

Name	Type
value	number

Returns

void

---

instanceID

• get instanceID(): number

实例ID。

Returns

number

Inherited from

Resource.instanceID

---

internalPtr

• get internalPtr(): io_ptr

实例内部指针。

Returns

io_ptr

Inherited from

Resource.internalPtr

---

label

• get label(): string

实例用户可理解的外部标签。

Returns

string

Inherited from

Resource.label

• set label(label): void

Parameters

Name	Type
label	string

Returns

void

Inherited from

Resource.label

---

lastcfw

• get lastcfw(): Float32Array

上一帧变换矩阵：世界->裁剪。

Returns

Float32Array

---

nearZ

• get nearZ(): number

近平面距离（理论上作为相机参数，但因为读取前必然应用，所以也可以读取作为着色器应用值）。

Returns

number

• set nearZ(value): void

Parameters

Name	Type
value	number

Returns

void

---

package

• get package(): Package

资源所属资源包。

Returns

Package

Inherited from

Resource.package

---

pitch

• get pitch(): number

相机俯角。

Returns

number

• set pitch(value): void

Parameters

Name	Type
value	number

Returns

void

---

position

• get position(): ArrayLike<number>

相机坐标（全局空间）。

Returns

ArrayLike<number>

---

ptrObject

• get ptrObject(): io_ptr

相机组件所属对象。

Returns

io_ptr

---

readTS

• get readTS(): number

数据应用时间戳。

Returns

number

• set readTS(value): void

Parameters

Name	Type
value	number

Returns

void

---

reprojection

• get reprojection(): Float32Array

重投影矩阵：当前相机空间->世界空间->旧相机空间->旧相机裁剪空间->上一相机屏幕空间。

Returns

Float32Array

---

roll

• get roll(): number

相机翻滚角。

Returns

number

• set roll(value): void

Parameters

Name	Type
value	number

Returns

void

---

skyLuminance

• get skyLuminance(): number

天空球IBL的整体强度。

Returns

number

• set skyLuminance(value): void

Parameters

Name	Type
value	number

Returns

void

---

skyPitch

• get skyPitch(): number

天空球绕X轴旋转角度。

Returns

number

• set skyPitch(value): void

Parameters

Name	Type
value	number

Returns

void

---

skyRoll

• get skyRoll(): number

天空球绕Z轴旋转角度。

Returns

number

• set skyRoll(value): void

Parameters

Name	Type
value	number

Returns

void

---

skySH

• get skySH(): Float32Array

天空球IBL的球谐系数。

Returns

Float32Array

• set skySH(value): void

Parameters

Name	Type
value	ArrayLike<number>

Returns

void

---

skyYaw

• get skyYaw(): number

天空球绕Y轴旋转角度。

Returns

number

• set skyYaw(value): void

Parameters

Name	Type
value	number

Returns

void

---

state

• get state(): ResState

实例状态。

Returns

ResState

Inherited from

Resource.state

---

sunColorIntensity

• get sunColorIntensity(): Float32Array

天空盒IBL的主光照颜色和强度。

Returns

Float32Array

---

sunDirection

• get sunDirection(): Float32Array

天空盒IBL的主光照方向（全局空间）。

Returns

Float32Array

---

target

• get target(): Float32Array

观察目标坐标（世界空间）。

Returns

Float32Array

• set target(value): void

Parameters

Name	Type
value	ArrayLike<number>

Returns

void

---

updated

• get updated(): number

数据更新状态。

Returns

number

• set updated(value): void

Parameters

Name	Type
value	number

Returns

void

---

uvfv

• get uvfv(): Float32Array

变换矩阵：相机->UV。

Returns

Float32Array

---

vfc

• get vfc(): Float32Array

变换矩阵：裁剪->相机。

Returns

Float32Array

---

vfg

• get vfg(): Float32Array

变换矩阵：全局->相机。

Returns

Float32Array

---

wdirection

• get wdirection(): Vector3

相机观察向量（世界空间）。

Returns

Vector3

---

wfg

• get wfg(): Float32Array

变换矩阵：全局->世界。

Returns

Float32Array

---

width

• get width(): number

画布宽度。

Returns

number

• set width(value): void

Parameters

Name	Type
value	number

Returns

void

---

wposition

• get wposition(): Vector3

相机坐标（世界空间）。

Returns

Vector3

---

writeTS

• get writeTS(): number

数据更新时间戳。

Returns

number

• set writeTS(value): void

Parameters

Name	Type
value	number

Returns

void

---

yaw

• get yaw(): number

相机偏航角。

Returns

number

• set yaw(value): void

Parameters

Name	Type
value	number

Returns

void

Methods

Clear

▸ Clear(): void

清除资源内部状态。

Returns

void

Inherited from

Resource.Clear

---

FixContent

▸ FixContent(bounding): void

使相机姿态适应观察内容范围。

Parameters

Name	Type	Description
bounding	Object	观察内容范围。
bounding.center	Vector3	-
bounding.radius	number	-

Returns

void

---

Init

▸ Init(_package, _asset): Promise<Camera>

异步初始化资源实例

Parameters

Name	Type	Description
_package	Package	资源包实例。
_asset	Asset	资源数据。

Returns

Promise<Camera>

返回异步对象。

Inherited from

Resource.Init

---

Move

▸ Move(offsetX, offsetY, width, height): void

标准的相机平移控制方法。

Parameters

Name	Type	Description
offsetX	number	光标横向平移像素数。
offsetY	number	光标纵向平移像素数。
width	number	光标焦点画布宽度。
height	number	光标焦点画布高度。

Returns

void

---

Rotate

▸ Rotate(offsetX, offsetY, width, height): void

标准的相机旋转控制方法。

Parameters

Name	Type	Description
offsetX	number	光标横向平移像素数。
offsetY	number	光标纵向平移像素数。
width	number	光标焦点画布宽度。
height	number	光标焦点画布高度。

Returns

void

---

Scale

▸ Scale(delta, width, height): void

标准的相机缩放控制方法。

Parameters

Name	Type	Description
delta	number	滚轮滚动方向。
width	number	光标焦点画布宽度。
height	number	光标焦点画布高度。

Returns

void

---

ScreenPointToRay

▸ ScreenPointToRay(pointX, pointY): Object

相机屏幕坐标转射线。

Parameters

Name	Type	Description
pointX	number	屏幕坐标X[0, 1]。
pointY	number	屏幕坐标Y[0, 1]。

Returns

Object

Name	Type
dir	Vector3
origin	Vector3