Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transform3D

export

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

  • new Transform3D(entity: Entity3D, _rawNativeValue?: Float32Array): Transform3D

  • 请使用engine.game.createEntity3D(name)创建3D对象

    memberof

    Transform3D

    Parameters

    • entity: Entity3D
    • Optional _rawNativeValue: Float32Array

    Returns Transform3D

Events

onDeserialized

  • onDeserialized(data: any): void

  • Parameters

    • data: any

    Returns void

Properties

Readonly entity

entity: Entity3D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Static Readonly OFFSETS

OFFSETS: Readonly<{ LOCALEULER: number; LOCALMATRIX: number; ROTATIONMATRIX: number; WORLDEULER: number; WORLDFORWARD: number; WORLDQUATERNION: number; WORLDRIGHT: number; WORLDSCALE: number; WORLDUP: number }> = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Readonly RAW2DLENGTH

RAW2DLENGTH: 4 = 4

Static Readonly RAWLENGTH

RAWLENGTH: 48 = 48

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void

  • 组件本身是否active

    overload
    memberof

    Component

    Returns boolean

  • 组件本身是否active

    Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean

  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

activeInHierarchyChangedEvent

  • get activeInHierarchyChangedEvent(): Emitter<void, void>

  • active状态变更事件监听器

    memberof

    TransformBase

    Returns Emitter<void, void>

anchor

  • local锚点

    memberof

    Transform3D

    Returns Vector2

  • local锚点

    Parameters

    Returns void

anchorX

  • get anchorX(): number
  • set anchorX(val: number): void

  • 本地锚点x分量

    memberof

    Transform3D

    Returns number

  • 本地锚点x分量

    Parameters

    • val: number

    Returns void

anchorY

  • get anchorY(): number
  • set anchorY(val: number): void

  • 本地锚点y分量

    memberof

    Transform3D

    Returns number

  • 本地锚点y分量

    Parameters

    • val: number

    Returns void

childChangeEvent

children

  • Returns TransformBase[]

childrenCount

  • get childrenCount(): number

  • 子节点数量

    readonly
    memberof

    TransformBase

    Returns number

euler

  • 本地旋转，用欧拉角表示

    memberof

    Transform3D

    Returns Vector3

  • 本地旋转，用欧拉角表示

    Parameters

    Returns void

forward

  • get forward(): DeepImmutableObject<Vector3>

  • 世界空间前方向，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Vector3>

localMatrix

  • get localMatrix(): DeepImmutableObject<Matrix4>

  • 本地RTS矩阵，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Matrix4>

parent

  • 父节点

    readonly
    memberof

    TransformBase

    Returns TransformBase

pivot

  • local锚点
    也支持通过pivot获取和设置

    memberof

    Transform3D

    Returns Vector2

  • local锚点
    也支持通过pivot获取和设置

    Parameters

    Returns void

position

  • 本地位置

    memberof

    Transform3D

    Returns Vector3

  • 本地位置

    Parameters

    Returns void

quaternion

  • 本地旋转，用四元数表示

    memberof

    Transform3D

    Returns Quaternion

  • 本地旋转，用四元数表示

    Parameters

    Returns void

right

  • get right(): DeepImmutableObject<Vector3>

  • 世界空间右方向，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Vector3>

scale

  • 本地缩放

    memberof

    Transform3D

    Returns Vector3

  • 本地缩放

    Parameters

    Returns void

size

  • local尺寸

    memberof

    Transform3D

    Returns Vector2

  • local尺寸

    Parameters

    Returns void

sizeX

  • get sizeX(): number
  • set sizeX(val: number): void

  • local尺寸x分量

    memberof

    Transform3D

    Returns number

  • local尺寸x分量

    Parameters

    • val: number

    Returns void

sizeY

  • get sizeY(): number
  • set sizeY(val: number): void

  • local尺寸y分量

    memberof

    Transform3D

    Returns number

  • local尺寸y分量

    Parameters

    • val: number

    Returns void

up

  • get up(): DeepImmutableObject<Vector3>

  • 世界空间上方向，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Vector3>

worldEuler

  • get worldEuler(): DeepImmutableObject<Vector3>

  • 世界空间旋转，用欧拉角表示

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Vector3>

worldMatrix

  • get worldMatrix(): DeepImmutableObject<Matrix4>

  • 世界RTS矩阵，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Matrix4>

worldMatrixDirtyEvent

  • get worldMatrixDirtyEvent(): Emitter<void, void>

  • 世界矩阵变更事件监听器

    memberof

    TransformBase

    Returns Emitter<void, void>

worldPosition

  • 世界位置，只读

    readonly
    memberof

    Transform3D

    Returns Vector3

  • 世界位置，只读

    Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): DeepImmutableObject<Quaternion>

  • 世界空间旋转，用四元数表示

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Quaternion>

worldRotationMatrix

  • get worldRotationMatrix(): DeepImmutableObject<Matrix4>

  • 世界空间旋转，用矩阵表示

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Matrix4>

worldScale

  • get worldScale(): DeepImmutableObject<Vector3>

  • 世界空间缩放，只读

    readonly
    memberof

    Transform3D

    Returns DeepImmutableObject<Vector3>

Methods

addChild

  • 添加子节点，若子节点已存在父节点，则会先移除其父节点
    子节点必须是Transform3D

    memberof

    Transform3D

    Parameters

    Returns boolean

    添加是否成功

addChildAtIndex

  • addChildAtIndex(child: Transform3D, index: number): boolean

  • 添加子节点到指定index，若子节点已存在父节点，则会先移除其父节点
    子节点必须是Transform3D

    memberof

    Transform3D

    Parameters

    • child: Transform3D

      子节点

    • index: number

      index顺序

    Returns boolean

    添加是否成功

convertWorldPositionToLocal

  • 将世界坐标转换为本地坐标系坐标

    memberof

    Transform3D

    Parameters

    • worldPosition: DeepImmutableObject<Vector3>

      世界坐标

    • Optional dst: Vector3

    Returns Vector3

    本地坐标系坐标

destroy

  • destroy(): void

findChildByName

getSiblingIndex

  • getSiblingIndex(): number

  • 获取同级索引

    memberof

    TransformBase

    Returns number

getTypeName

  • getTypeName(): string

immovableAfter

  • 在当前节点后插入新的节点, 新插入的节点世界矩阵不变

    memberof

    Transform3D

    Parameters

    Returns boolean

    是否插入成功

immovableAppendTo

  • 把当前节点添加到指定的parent节点里，作为其子节点。 当前节点世界矩阵不变

    memberof

    Transform3D

    Parameters

    Returns boolean

    是否插入成功

immovableBefore

  • 在当前节点前插入新的节点, 新插入的节点世界矩阵不变

    memberof

    Transform3D

    Parameters

    Returns boolean

    是否插入成功

isDetached

  • isDetached(): boolean

removeChild

  • 移除子节点

    memberof

    Transform3D

    Parameters

    Returns boolean

    是否移除成功

resetProperties

  • resetProperties(): void

rotate

  • rotate(rotation: DeepImmutableObject<Vector3>, isLocal?: boolean, isRadian?: boolean): void

  • 对自身做旋转变换。

    memberof

    Transform3D

    Parameters

    • rotation: DeepImmutableObject<Vector3>

      旋转幅度。

    • Optional isLocal: boolean
    • Optional isRadian: boolean

    Returns void

setSiblingIndex

  • setSiblingIndex(index: number): void

  • 设置同级索引

    memberof

    TransformBase

    Parameters

    • index: number

      同级索引序号

    Returns void

travelChild

Generated using TypeDoc