Class TransformGizmo

编辑轴对象

Export

Date

2023.3.27

Author

yj

Hierarchy

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable queryMask userData

Accessors

axis bounds dragging enabled engine entity eye mode object3D occluded position quaternion renderOrder rotation rotationAngle rotationAxis scale showX showY showZ space visible worldPosition worldPositionStart worldQuaternion worldQuaternionStart worldScale worldScaleStart

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener destroy dispatchEvent dispose localToWorld onCameraChanged raycast recoverMaterial removeAllEventListeners removeEventListener removeEventListenerByEventId replaceMaterial setActive setClipping setHighlight setStencil setTransform updateProperties worldToLocal

Constructors

constructor

Properties

Protected _bounds

_bounds: Box3 = ...

Protected _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _object3D

_object3D: Object3D<Object3DEventMap>

Protected _renderOrder

_renderOrder: RenderOrder

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

axis

  • get axis(): string

  • 获取选中编辑轴

    Returns string

    Memberof

    TransformGizmo

  • set axis(value): void

  • 设置选中编辑轴

    Parameters

    • value: string

    Returns void

    Memberof

    TransformGizmo

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

dragging

  • get dragging(): boolean

  • 获取是否处于编辑状态

    Returns boolean

    Memberof

    TransformGizmo

  • set dragging(value): void

  • 设置是否处于编辑状态

    Parameters

    • value: boolean

    Returns void

    Memberof

    TransformGizmo

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

eye

  • get eye(): number[] | Vector3

  • 获取视线方向

    Returns number[] | Vector3

    Memberof

    TransformGizmo

  • set eye(value): void

  • 设置视线

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    TransformGizmo

mode

  • get mode(): string

  • 获取模式mode

    Returns string

    Memberof

    TransformGizmo

  • set mode(value): void

  • 设置mode

    Parameters

    • value: string

    Returns void

    Memberof

    TransformGizmo

object3D

  • get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  • 获取渲染组件对应的Object3D（three.js）对象

    Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Memberof

    Renderable

occluded

  • get occluded(): boolean

  • 获取编辑轴是否可被遮挡

    Returns boolean

    Memberof

    TransformGizmo

  • set occluded(value): void

  • 设置编辑轴是否可被遮挡

    Parameters

    • value: boolean

    Returns void

    Memberof

    TransformGizmo

position

  • get position(): Vector3

  • 获取本地位置

    Returns Vector3

    Memberof

    Renderable

  • set position(value): void

  • 设置本地位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

quaternion

  • get quaternion(): Quaternion

  • 获取本地旋转四元数

    Returns Quaternion

    Memberof

    Renderable

  • set quaternion(value): void

  • 设置本地旋转四元数

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    Renderable

renderOrder

  • get renderOrder(): RenderOrder

  • 获取渲染顺序

    Returns RenderOrder

    Memberof

    Renderable

  • set renderOrder(value): void

  • 设置渲染顺序

    Parameters

    Returns void

    Memberof

    Renderable

rotation

  • get rotation(): Euler

  • 获取本地旋转角（单位：弧度）

    Returns Euler

    Memberof

    Renderable

  • set rotation(value): void

  • 设置本地旋转角（单位：弧度）

    Parameters

    • value: number[] | Euler

    Returns void

    Memberof

    Renderable

rotationAngle

  • get rotationAngle(): number

  • 获取旋转角度

    Returns number

    Memberof

    TransformGizmo

  • set rotationAngle(value): void

  • 设置旋转轴角度

    Parameters

    • value: number

    Returns void

    Memberof

    TransformGizmo

rotationAxis

  • get rotationAxis(): number[] | Vector3

  • 获取旋转轴

    Returns number[] | Vector3

    Memberof

    TransformGizmo

  • set rotationAxis(value): void

  • 设置旋转轴

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    TransformGizmo

scale

  • get scale(): Vector3

  • 获取本地缩放

    Returns Vector3

    Memberof

    Renderable

  • set scale(value): void

  • 设置本地缩放

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

showX

  • get showX(): boolean

  • 获取X轴可见性

    Returns boolean

    Memberof

    TransformGizmo

  • set showX(value): void

  • 设置X轴可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    TransformGizmo

showY

  • get showY(): boolean

  • 获取Y轴可见性

    Returns boolean

    Memberof

    TransformGizmo

  • set showY(value): void

  • 设置Y轴可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    TransformGizmo

showZ

  • get showZ(): boolean

  • 获取Z轴可见性

    Returns boolean

    Memberof

    TransformGizmo

  • set showZ(value): void

  • 设置Z轴可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    TransformGizmo

space

  • get space(): string

  • 编辑空间

    Returns string

    Memberof

    TransformGizmo

  • set space(value): void

  • 设置编辑空间

    Parameters

    • value: string

    Returns void

    Memberof

    TransformGizmo

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

worldPosition

  • get worldPosition(): Readonly<Vector3>

  • 获取编辑轴世界坐标

    Returns Readonly<Vector3>

    Memberof

    TransformGizmo

  • set worldPosition(value): void

  • 设置编辑轴世界坐标

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    TransformGizmo

worldPositionStart

  • get worldPositionStart(): Readonly<Vector3>

  • 获取编辑轴初始位置

    Returns Readonly<Vector3>

    Memberof

    TransformGizmo

  • set worldPositionStart(value): void

  • 设置编辑轴初始世界位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    TransformGizmo

worldQuaternion

  • get worldQuaternion(): Readonly<Quaternion>

  • 获取编辑轴世界旋转量

    Returns Readonly<Quaternion>

    Memberof

    TransformGizmo

  • set worldQuaternion(value): void

  • 设置编辑轴世界旋转量

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    TransformGizmo

worldQuaternionStart

  • get worldQuaternionStart(): Readonly<Quaternion>

  • 获取编辑轴初始旋转量

    Returns Readonly<Quaternion>

    Memberof

    TransformGizmo

  • set worldQuaternionStart(value): void

  • 设置编辑轴初始世界旋转量

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    TransformGizmo

worldScale

  • get worldScale(): Vector3

  • 获取世界缩放

    Returns Vector3

    Memberof

    Renderable

worldScaleStart

  • get worldScaleStart(): Readonly<Vector3>

  • 获取编辑轴初始缩放量

    Returns Readonly<Vector3>

    Memberof

    TransformGizmo

  • set worldScaleStart(value): void

  • 设置编辑轴初始世界缩放量

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    TransformGizmo

Methods

Protected _destroy

  • _destroy(): void
  • Protected

    销毁接口

    Returns void

    Memberof

    TransformGizmo

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁渲染组件

    Returns void

    Memberof

    Renderable

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用组件

    Returns void

    Memberof

    TransformGizmo

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用组件

    Returns void

    Memberof

    TransformGizmo

Protected _updateBounds

  • _updateBounds(): void
  • Protected

    更新渲染组件外包盒

    Returns void

    Memberof

    Renderable

Protected _updateMatrixWorld

  • _updateMatrixWorld(): void
  • Protected

    更新渲染组件世界矩阵

    Returns void

    Memberof

    Renderable

Protected _updateRenderOrder

addEventListener

  • 添加事件监听器

    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

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

      本地坐标

    Returns Vector3

    Memberof

    Renderable

onCameraChanged

  • 相机改变回调

    Parameters

    • event: any

    Returns void

    Memberof

    TransformGizmo

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    TransformGizmo

recoverMaterial

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    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

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

replaceMaterial

  • 替换材质

    Parameters

    • material: any

      材质对象

    Returns void

    Memberof

    Renderable

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setClipping

setHighlight

  • 设置是否高亮

    Parameters

    Returns void

    Memberof

    Renderable

setStencil

  • 设置模板参数

    Parameters

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    Returns void

    Memberof

    Renderable

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

      世界坐标

    Returns Vector3

    Memberof

    Renderable

Settings

Member Visibility

Theme

On This Page