Class Transform

方位变换组件

Export

Date

2022.3.19

Author

lyx

Hierarchy

Component
- Transform

Constructors

constructor

new Transform(entity, parameters?): Transform
Parameters
- entity: Entity
- parameters: TransformParameters = {}
Returns Transform

Overrides Component.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

userData

userData: {
[key: string]: any;
} = {}

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

bounds

get bounds(): Readonly<Box3>
获取世界外包范围（包含孩子的世界外包范围）

Returns Readonly<Box3>

Memberof
Transform

children

get children(): readonly Transform[]
获取子方位组件

Returns readonly Transform[]

Memberof
Transform

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Component.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Component.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Component.entity

matrix

set matrix(value): void
设置矩阵
Parameters
- value: Matrix4
Returns void

Memberof
Transform

parent

get parent(): Transform
获取父方位组件

Returns Transform

Memberof
Transform
set parent(transform): void
设置父方位组件
Parameters
- transform: Transform
Returns void

Memberof
Transform

position

get position(): Vector3
获取位置

Returns Vector3

Memberof
Transform
set position(value): void
设置位置
Parameters
- value: number[] | Vector3
Returns void

Memberof
Transform

quaternion

get quaternion(): Quaternion
获取旋转四元数

Returns Quaternion

Memberof
Transform
set quaternion(value): void
设置旋转四元数
Parameters
- value: number[] | Quaternion
Returns void

Memberof
Transform

rotation

get rotation(): Euler
获取旋转欧拉角

Returns Euler

Memberof
Transform
set rotation(value): void
设置旋转欧拉角
Parameters
- value: number[] | Euler
Returns void

Memberof
Transform

scale

get scale(): Vector3
获取缩放量

Returns Vector3

Memberof
Transform
set scale(value): void
设置缩放量
Parameters
- value: number[] | Vector3
Returns void

Memberof
Transform

scene

get scene(): Transform
获取所属场景方位组件

Returns Transform

Memberof
Transform

sceneNode

get sceneNode(): Readonly<Object3D<Object3DEventMap>>
获取场景结点

Returns Readonly<Object3D<Object3DEventMap>>

Memberof
Transform

visible

get visible(): boolean
获取可见性

Returns boolean

Memberof
Transform
set visible(value): void
设置可见性
Parameters
- value: boolean
Returns void

Memberof
Transform

worldDirection

get worldDirection(): Vector3
获取世界朝向

Returns Vector3

Memberof
Transform

worldPosition

get worldPosition(): Vector3
获取世界位置

Returns Vector3

Memberof
Transform

worldQuaternion

get worldQuaternion(): Quaternion
获取世界旋转四元数

Returns Quaternion

Memberof
Transform

worldScale

get worldScale(): Vector3
获取世界缩放量

Returns Vector3

Memberof
Transform

Methods

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from Component._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁组件

Returns void

Memberof
Transform

Overrides Component._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用组件

Returns void

Memberof
Component

Inherited from Component._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用组件

Returns void

Memberof
Component

Inherited from Component._onEnable

addChild

addChild(child): Transform
添加一个子方位组件
Parameters
- child: Transform
Returns Transform

Memberof
Transform

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Component.addEventListener

addObject3D

addObject3D(object): void
添加一个Object3D对象
Parameters
- object: Object3D<Object3DEventMap>
Returns void

Memberof
Transform

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Component.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Component.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Component.dispose

getWorldBounds

getWorldBounds(recursive): Readonly<Box3>
获取世界外包范围
Parameters
- recursive: boolean
  
  是否包含子世界外包范围
Returns Readonly<Box3>

Memberof
Transform

localToWorld

localToWorld(vector): Vector3
本地坐标转世界坐标
Parameters
- vector: number[] | Vector3
  
  本地坐标
Returns Vector3

Memberof
Transform

lookAt

lookAt(target): void
旋转组件使其在世界空间中朝向目标点
Parameters
- target: number[] | Vector3
  
  目标点（世界坐标）
Returns void

Memberof
Transform

registerUpdateFlag

registerUpdateFlag(): BoolUpdateFlag
注册一个方位更新标志

Returns BoolUpdateFlag

Memberof
Transform

removeAllChildren

removeAllChildren(): Transform
移除所有子方位组件

Returns Transform

Memberof
Transform

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Component.removeAllEventListeners

removeChild

removeChild(child): Transform
移除一个子方位组件
Parameters
- child: Transform
Returns Transform

Memberof
Transform

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListenerByEventId

removeFromParent

removeFromParent(): Transform
从父方位组件移除该方位组件

Returns Transform

Memberof
Transform

removeObject3D

removeObject3D(object): void
移除一个Object3D对象
Parameters
- object: Object3D<Object3DEventMap>
Returns void

Memberof
Transform

rotateOnAxis

rotateOnAxis(axis, angle): void
绕本地坐标轴旋转
Parameters
- axis: number[] | Vector3
  
  本地坐标轴（需要单位化）
- angle: number
  
  旋转角度（单位：弧度）
Returns void

Memberof
Transform

rotateOnWorldAxis

rotateOnWorldAxis(axis, angle): void
绕世界坐标轴旋转
Parameters
- axis: number[] | Vector3
  
  世界坐标轴（需要单位化）
- angle: number
  
  旋转角度（单位：弧度）
Returns void

Memberof
Transform

rotateX

rotateX(angle): void
绕本地X轴旋转
Parameters
- angle: number
  
  旋转角度（单位：弧度）
Returns void

Memberof
Transform

rotateY

rotateY(angle): void
绕本地Y轴旋转
Parameters
- angle: number
  
  旋转角度（单位：弧度）
Returns void

Memberof
Transform

rotateZ

rotateZ(angle): void
绕本地Z轴旋转
Parameters
- angle: number
  
  旋转角度（单位：弧度）
Returns void

Memberof
Transform

set

set(transformation): void
设置方位信息
Parameters
- transformation: Transformation
  
  方位信息
Returns void

Memberof
Transform

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.setActive

translateOnAxis

translateOnAxis(axis, distance): void
沿本地坐标轴平移
Parameters
- axis: number[] | Vector3
  
  本地坐标轴（需要单位化）
- distance: number
  
  平移距离
Returns void

Memberof
Transform

translateX

translateX(distance): void
沿本地X轴平移
Parameters
- distance: number
  
  平移距离
Returns void

Memberof
Transform

translateY

translateY(distance): void
沿本地Y轴平移
Parameters
- distance: number
  
  平移距离
Returns void

Memberof
Transform

translateZ

translateZ(distance): void
沿本地Z轴平移
Parameters
- distance: number
  
  平移距离
Returns void

Memberof
Transform

traverse

traverse(callback): void
遍历自身以及后代并执行回调函数
Parameters
- callback: ((child) => void)
  - - (child): void
    - Parameters
      
      child: Transform
      
      Returns void
Returns void

Memberof
Transform

traverseVisible

traverseVisible(callback): void
遍历可见的自身以及后代并执行回调函数
Parameters
- callback: ((child) => void)
  - - (child): void
    - Parameters
      
      child: Transform
      
      Returns void
Returns void

Memberof
Transform

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Component.updateProperties

updateTransform

updateTransform(matrixAutoUpdate?): void
更新方位信息
Parameters
- Optional matrixAutoUpdate: boolean = true
  
  是否自动更新矩阵
Returns void

Memberof
Transform

worldToLocal

worldToLocal(vector): Vector3
世界坐标转本地坐标
Parameters
- vector: number[] | Vector3
  
  世界坐标
Returns Vector3

Memberof
Transform