Object3D

Ploy3D / Object3D

Class: Object3D

3D对象实例。

Hierarchy

• Resource<Object3D>

  ↳ Object3D

Table of contents

Constructors

• constructor

Accessors

• active
• animator
• childCount
• classid
• customID
• eulerAngles
• flags
• forward
• guid
• highlight
• instanceID
• internalPtr
• label
• lastSib
• layers
• localEulerAngles
• localPosition
• localRotation
• localScale
• localToWorldMatrix
• name
• nextSib
• package
• parent
• parentID
• parentTS
• position
• ptrAnimator
• ptrCamera
• ptrChildren
• ptrMeshRenderer
• ptrParent
• ptrScene
• readTS
• renderer
• right
• root
• rotation
• state
• tag
• up
• worldToLocalMatrix
• writeTS

Methods

• Clear
• Destroy
• ForEachChild
• GetAABB
• Init
• LookAt
• Rotate
• RotateAround
• RotateAxis
• SetParent
• SetPositionAndRotation
• Translate

Constructors

constructor

• new Object3D(id)

构造函数。

Parameters

Name	Type	Description
id	number	资源实例ID。

Overrides

Resource.constructor

Accessors

active

• get active(): boolean

对象激活状态。

Returns

boolean

• set active(b): void

Parameters

Name	Type
b	boolean

Returns

void

---

animator

• get animator(): Animator

动画组件。

Returns

Animator

---

childCount

• get childCount(): number

子级数量。

Returns

number

---

classid

• get classid(): ClassID

实例类型ID。

Returns

ClassID

Inherited from

Resource.classid

---

customID

• get customID(): number

用户定义ID。

Returns

number

• set customID(value): void

Parameters

Name	Type
value	number

Returns

void

---

eulerAngles

• get eulerAngles(): Vector3

世界空间旋转欧拉角（单位度）。

Returns

Vector3

---

flags

• get flags(): number

对象标记集：1-是否激活，2-数据是否更新，4-是否应用了数据更新，8-是否高亮对象。

Returns

number

• set flags(value): void

Parameters

Name	Type
value	number

Returns

void

---

forward

• get forward(): Vector3

世界空间前向量。

Returns

Vector3

---

guid

• get guid(): string

资源全球唯一ID。

Returns

string

Inherited from

Resource.guid

---

highlight

• get highlight(): boolean

对象高亮状态。

Returns

boolean

• set highlight(b): void

Parameters

Name	Type
b	boolean

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

---

lastSib

• get lastSib(): io_ptr

上一个兄弟变换组件指针。

Returns

io_ptr

---

layers

• get layers(): number

对象自定义层标记。

Returns

number

• set layers(value): void

Parameters

Name	Type
value	number

Returns

void

---

localEulerAngles

• get localEulerAngles(): Vector3

父级空间旋转欧拉角（单位度）。

Returns

Vector3

• set localEulerAngles(v): void

Parameters

Name	Type
v	Vector3

Returns

void

---

localPosition

• get localPosition(): Vector3

本地坐标（父级空间）。

Returns

Vector3

• set localPosition(value): void

Parameters

Name	Type
value	Vector3

Returns

void

---

localRotation

• get localRotation(): Quaternion

本地旋转（父级空间）。

Returns

Quaternion

• set localRotation(value): void

Parameters

Name	Type
value	Quaternion

Returns

void

---

localScale

• get localScale(): Vector3

本地缩放（父级空间）。

Returns

Vector3

• set localScale(value): void

Parameters

Name	Type
value	Vector3

Returns

void

---

localToWorldMatrix

• get localToWorldMatrix(): Matrix4x4

对象空间到世界空间变换矩阵。

Returns

Matrix4x4

---

name

• get name(): string

对象名称。

Returns

string

• set name(name): void

Parameters

Name	Type
name	string

Returns

void

---

nextSib

• get nextSib(): io_ptr

下一个兄弟变换组件指针。

Returns

io_ptr

---

package

• get package(): Package

资源所属资源包。

Returns

Package

Inherited from

Resource.package

---

parent

• get parent(): Object3D

父级变换组件。

Returns

Object3D

---

parentID

• get parentID(): number

父级变换组件用户定义ID。

Returns

number

---

parentTS

• get parentTS(): number

父级变换组件应用时间戳。

Returns

number

---

position

• get position(): Vector3

世界空间坐标。

Returns

Vector3

• set position(pos): void

Parameters

Name	Type
pos	Vector3

Returns

void

---

ptrAnimator

• get ptrAnimator(): io_ptr

动画播放器组件指针。

Returns

io_ptr

---

ptrCamera

• get ptrCamera(): io_ptr

相机组件指针。

Returns

io_ptr

---

ptrChildren

• get ptrChildren(): io_ptr

子级变换组件链表头指针。

Returns

io_ptr

---

ptrMeshRenderer

• get ptrMeshRenderer(): io_ptr

网格渲染器组件指针。

Returns

io_ptr

---

ptrParent

• get ptrParent(): io_ptr

父级变换组件指针。

Returns

io_ptr

---

ptrScene

• get ptrScene(): io_ptr

所属场景。

Returns

io_ptr

---

readTS

• get readTS(): number

变换组件应用时间戳。

Returns

number

---

renderer

• get renderer(): MeshRenderer

网格渲染器组件。

Returns

MeshRenderer

---

right

• get right(): Vector3

世界空间右向量。

Returns

Vector3

---

root

• get root(): Object3D

层次结构中最顶级对象变换组件。

Returns

Object3D

---

rotation

• get rotation(): Quaternion

旋转（世界空间，缩放造成空间尺度变形，方向被扭曲，所以带缩放的变换矩阵变换方向无法得到等比例空间的方向）。

Returns

Quaternion

• set rotation(q): void

Parameters

Name	Type
q	Quaternion

Returns

void

---

state

• get state(): ResState

实例状态。

Returns

ResState

Inherited from

Resource.state

---

tag

• get tag(): number

对象标签。

Returns

number

• set tag(tag): void

Parameters

Name	Type
tag	number

Returns

void

---

up

• get up(): Vector3

世界空间上向量。

Returns

Vector3

---

worldToLocalMatrix

• get worldToLocalMatrix(): Matrix4x4

世界空间到对象空间变换矩阵。

Returns

Matrix4x4

---

writeTS

• get writeTS(): number

变换组件更新时间戳。

Returns

number

Methods

Clear

▸ Clear(): void

清除资源内部状态。

Returns

void

Inherited from

Resource.Clear

---

Destroy

▸ Destroy(): void

销毁对象。

Returns

void

---

ForEachChild

▸ ForEachChild(proc): void

遍历处理每个子对象。

Parameters

Name	Type
proc	(index: number, obj: Object3D) => void

Returns

void

---

GetAABB

▸ GetAABB(withChildren): Object

获取对象包围盒。

Parameters

Name	Type
withChildren	boolean

Returns

Object

Name	Type
center	Vector3
extents	Vector3

---

Init

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

异步初始化资源实例

Parameters

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

Returns

Promise<Object3D>

返回异步对象。

Inherited from

Resource.Init

---

LookAt

▸ LookAt(worldPosition, worldUp): void

旋转变换组件使前向量朝向指定目标世界坐标。

Parameters

Name	Type	Description
worldPosition	Vector3	指定目标世界坐标。
worldUp	Vector3	指定世界空间上向量，避免变换组件自旋。

Returns

void

---

Rotate

▸ Rotate(eulers, relativeTo): void

绕指定参考空间3条轴旋转变换组件。

Parameters

Name	Type	Description
eulers	Vector3	欧拉角旋转参数（度）。
relativeTo	Object3D | "World" | "Self"	旋转参数相对空间。

Returns

void

---

RotateAround

▸ RotateAround(point, axis, angle): void

绕指定点和指定轴向旋转指定角度。

Parameters

Name	Type	Description
point	Vector3	旋转轴中心。
axis	Vector3	旋转轴方向。
angle	number	旋转角度。

Returns

void

---

RotateAxis

▸ RotateAxis(axis, angle, relativeTo): void

绕指定轴向旋转指定角度。

Parameters

Name	Type	Description
axis	Vector3	旋转轴方向。
angle	number	旋转角度。
relativeTo	Object3D | "World" | "Self"	旋转轴方向相对空间。

Returns

void

---

SetParent

▸ SetParent(parent, worldPositionStays?): void

设置父级变换组件。

Parameters

Name	Type	Description
parent	Object3D	-
worldPositionStays?	boolean	是否维持世界空间位置。

Returns

void

---

SetPositionAndRotation

▸ SetPositionAndRotation(position, rotation): void

设置并应用世界空间坐标和旋转。

Parameters

Name	Type	Description
position	Vector3	世界空间坐标。
rotation	Quaternion	世界空间旋转。

Returns

void

---

Translate

▸ Translate(translation, relativeTo): void

沿指定向量平移变换组件。

Parameters

Name	Type	Description
translation	Vector3	平移方向和距离。
relativeTo	Object3D | "World" | "Self"	平移向量相对空间。

Returns

void