Class RuntimeTransformHandle

Hierarchy

Tool<RTHOptions, RTHEventsMap>
- RuntimeTransformHandle

Index

Constructors

Properties

_selectedType alignedCenterToCamVec app basePlaneDistance centerPos centerRot centerToCamVec deltaElr deltaRotateMat dragVec entityRotationOffset entitysRotationOffset handleType invertTransformMat isDragging orbitCamera outLineCamera outLineColor pivotType planeEdge1XEntity planeEdge1YEntity planeEdge1ZEntity planeEdge2XEntity planeEdge2YEntity planeEdge2ZEntity planeFollowNormal planeHitVec planeIntersectPoint planeMoveNormal planeOffset planeOffsetVec planeProject planeToFollow planeToMove planeXAngle planeXEntity planeYAngle planeYEntity planeZAngle planeZEntity planesIntersectPoint planesOffset planesOffsetVec record rotateHandleScaler rotationHandle scaleHandle scaleHandleScaler screenVec screenVec2 startRotateVec startRotateVerticalVec startScales toolOptions toolOptionsDefault trackEntities trackTransforms transformHandle translationHandle viewMat

Accessors

enabled selectedType

Constructors

constructor

new RuntimeTransformHandle(options: RTHOptions): RuntimeTransformHandle
Parameters
- options: RTHOptions
Returns RuntimeTransformHandle
Overrides Tool.constructor
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:165

Properties

`Private` _selectedType

_selectedType: SelectType

`Private` alignedCenterToCamVec

alignedCenterToCamVec: Vec3

app

app: AppBase

`Private` basePlaneDistance

basePlaneDistance: number = 66

`Private` centerPos

centerPos: Vec3

`Private` centerRot

centerRot: Quat

`Private` centerToCamVec

centerToCamVec: Vec3

`Private` deltaElr

deltaElr: Vec3

`Private` deltaRotateMat

deltaRotateMat: Mat4

`Private` dragVec

dragVec: Vec2

`Private` entityRotationOffset

entityRotationOffset: Vec3

`Private` entitysRotationOffset

entitysRotationOffset: Vec3[]

`Private` handleType

handleType: HandleType = HandleType.Translation

`Private` invertTransformMat

invertTransformMat: Mat4

`Private` isDragging

isDragging: boolean = false

`Private` orbitCamera

orbitCamera: OrbitCamera

`Private` outLineCamera

outLineCamera: OutlineCamera

`Private` outLineColor

outLineColor: Color = ...

`Private` pivotType

pivotType: PivotType = PivotType.World

`Private` planeEdge1XEntity

planeEdge1XEntity: Entity

`Private` planeEdge1YEntity

planeEdge1YEntity: Entity

`Private` planeEdge1ZEntity

planeEdge1ZEntity: Entity

`Private` planeEdge2XEntity

planeEdge2XEntity: Entity

`Private` planeEdge2YEntity

planeEdge2YEntity: Entity

`Private` planeEdge2ZEntity

planeEdge2ZEntity: Entity

`Private` planeFollowNormal

planeFollowNormal: Vec3

`Private` planeHitVec

planeHitVec: Vec3

`Private` planeIntersectPoint

planeIntersectPoint: Vec3

`Private` planeMoveNormal

planeMoveNormal: Vec3

`Private` planeOffset

planeOffset: number

`Private` planeOffsetVec

planeOffsetVec: Vec3

`Private` planeProject

planeProject: Vec3

`Private` planeToFollow

planeToFollow: Plane

`Private` planeToMove

planeToMove: Plane

`Private` planeXAngle

planeXAngle: number

`Private` planeXEntity

planeXEntity: Entity

`Private` planeYAngle

planeYAngle: number

`Private` planeYEntity

planeYEntity: Entity

`Private` planeZAngle

planeZAngle: number

`Private` planeZEntity

planeZEntity: Entity

`Private` planesIntersectPoint

planesIntersectPoint: Vec3

`Private` planesOffset

planesOffset: number[]

`Private` planesOffsetVec

planesOffsetVec: Vec3[]

`Private` record

record: Record

`Private` rotateHandleScaler

rotateHandleScaler: number = 0.5

`Private` rotationHandle

rotationHandle: Entity

`Private` scaleHandle

scaleHandle: Entity

`Private` scaleHandleScaler

scaleHandleScaler: number = 0.0036

`Private` screenVec

screenVec: Vec3

`Private` screenVec2

screenVec2: Vec2

`Private` startRotateVec

startRotateVec: Vec3

`Private` startRotateVerticalVec

startRotateVerticalVec: Vec3

`Private` startScales

startScales: Vec3[]

toolOptions

toolOptions: RTHOptions

`Protected` toolOptionsDefault

toolOptionsDefault: RTHOptions = ...

`Private` trackEntities

trackEntities: Entity[]

`Private` trackTransforms

trackTransforms: Mat4[]

`Private` transformHandle

transformHandle: Entity

`Private` translationHandle

translationHandle: Entity

`Private` viewMat

viewMat: Mat4

Accessors

enabled

get enabled(): boolean
获得工具的启用状态

Returns boolean
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:43
set enabled(value: boolean): void
设置工具启用状态（触发启用和禁用时的额外操作）
Parameters
- value: boolean
Returns void
Inherited from Tool.enabled
- Defined in src/utils/helpers/toolBase.ts:34

`Private` selectedType

get selectedType(): SelectType
Returns SelectType
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:134
set selectedType(value: SelectType): void
Parameters
- value: SelectType
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:138

Methods

`Protected` fire

fire<EventName>(eventName: EventName, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, arg6?: any, arg7?: any, arg8?: any): EventHandler
手动触发事件

Returns
EventHandler
Type Parameters
- EventName extends keyof RTHEventsMap
Parameters
- eventName: EventName
  
  事件名称
- Optional arg1: any
  
  参数1
- Optional arg2: any
  
  参数2
- Optional arg3: any
  
  参数3
- Optional arg4: any
  
  参数4
- Optional arg5: any
  
  参数5
- Optional arg6: any
  
  参数6
- Optional arg7: any
  
  参数7
- Optional arg8: any
  
  参数8
Returns EventHandler
Inherited from Tool.fire
- Defined in src/utils/helpers/toolBase.ts:128

focus

focus(): void
聚焦选中物体

Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:358

hasEvent

hasEvent<EventName>(eventName: EventName): boolean
检测是否监听此事件

Returns
是否监听此事件
Type Parameters
- EventName extends keyof RTHEventsMap
Parameters
- eventName: EventName
  
  事件名称
Returns boolean
Inherited from Tool.hasEvent
- Defined in src/utils/helpers/toolBase.ts:111

look

look(target: Entity | Entity[]): void
相机看向目标
Parameters
- target: Entity | Entity[]
  
  目标物体
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:411

off

off<EventName>(eventName: EventName, linstener: RTHEventsMap[EventName], scope?: object): EventHandler
注销事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof RTHEventsMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: RTHEventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.off
- Defined in src/utils/helpers/toolBase.ts:102

on

on<EventName>(eventName: EventName, linstener: RTHEventsMap[EventName], scope?: object): EventHandler
注册事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof RTHEventsMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: RTHEventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.on
- Defined in src/utils/helpers/toolBase.ts:80

`Private` onControlDown

onControlDown(event: { x: number; y: number }): void
鼠标或触屏按下时触发的事件
Parameters
- event: { x: number; y: number }
  
  事件
  - x: number
  - y: number
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:914

`Private` onControlMove

onControlMove(event: { dx: number; dy: number; x: number; y: number }): void
鼠标或触屏移动时触发的事件
Parameters
- event: { dx: number; dy: number; x: number; y: number }
  
  事件
  - dx: number
  - dy: number
  - x: number
  - y: number
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:1035

`Private` onControlUp

onControlUp(event: { x: number; y: number }): void
鼠标或触屏按键抬起时触发的事件
Parameters
- event: { x: number; y: number }
  
  事件
  - x: number
  - y: number
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:1056

`Protected` onDisable

onDisable(): void
Returns void
Overrides Tool.onDisable
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:1086

`Protected` onEnable

onEnable(): void
Returns void
Overrides Tool.onEnable
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:1084

`Private` onRotationHandleMove

onRotationHandleMove(currentCamera: CameraComponent, dx: number, dy: number): void
根据鼠标移动对选中物体进行旋转
Parameters
- currentCamera: CameraComponent
  
  当前渲染相机
- dx: number
  
  鼠标x增量
- dy: number
  
  鼠标y增量
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:810

`Private` onScaleHandleMove

onScaleHandleMove(currentCamera: CameraComponent, dx: number, dy: number): void
根据鼠标移动对选中物体进行放缩
Parameters
- currentCamera: CameraComponent
  
  当前渲染相机
- dx: number
  
  鼠标x增量
- dy: number
  
  鼠标y增量
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:848

`Private` onTranslationHandleMove

onTranslationHandleMove(currentCamera: CameraComponent, x: number, y: number): void
根据鼠标移动对选中物体进行位移
Parameters
- currentCamera: CameraComponent
  
  当前渲染相机
- x: number
  
  鼠标x
- y: number
  
  鼠标y
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:758

once

once<EventName>(eventName: EventName, linstener: RTHEventsMap[EventName], scope?: object): EventHandler
注册单次事件监听

Returns
EventHandler
Type Parameters
- EventName extends keyof RTHEventsMap
Parameters
- eventName: EventName
  
  事件名称
- linstener: RTHEventsMap[EventName]
  
  监听回调
- Optional scope: object
  
  回调函数this指向
Returns EventHandler
Inherited from Tool.once
- Defined in src/utils/helpers/toolBase.ts:91

redo

redo(): void
重做

Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:400

`Private` resetTransforms

resetTransforms(selections: Entity[], transforms: Mat4[]): void
根据记录还原模型的空间信息
Parameters
- selections: Entity[]
  
  选中模型
- transforms: Mat4[]
  
  选中模型的空间信息
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:895

select

select(target: Entity | Entity[], saveRecord?: boolean): void
选中模型
Parameters
- target: Entity | Entity[]
  
  选中的单个模型或模型数组（传入null时则取消选中）
- saveRecord: boolean = false
  
  是否保存记录
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:328

`Private` selectionIsEqual

selectionIsEqual(target: Entity | Entity[]): boolean
判断本次选择是否和上次相同
Parameters
- target: Entity | Entity[]
  
  选中的单个模型或模型数组
Returns boolean
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:420

setHandleType

setHandleType(type: HandleType): void
设置坐标轴类型
Parameters
- type: HandleType
  
  坐标轴类型
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:303

setOptions

setOptions(options: RTHOptions): void
设置选项
Parameters
- options: RTHOptions
  
  选项
Returns void
Inherited from Tool.setOptions
- Defined in src/utils/helpers/toolBase.ts:52

setPivotType

setPivotType(type: PivotType): void
设置中心点类型
Parameters
- type: PivotType
  
  中心点类型
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:317

switchPivot

switchPivot(pivot?: PivotType): void
切换轴心模式
Parameters
- Optional pivot: PivotType
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:370

undo

undo(): void
撤销

Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:390

`Private` update

update(dt: number): void
帧更新
Parameters
- dt: number
  
  本帧的时长
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:435

`Private` updateDisplay

updateDisplay(camera: CameraComponent): void
根据相机的角度，更新坐标轴的显示状态
Parameters
- camera: CameraComponent
  
  当前渲染相机
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:497

`Private` updateHandle

updateHandle(camera: CameraComponent): void
根据鼠标的位置，更新坐标轴的选中状态
Parameters
- camera: CameraComponent
  
  当前渲染相机
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:735

updateOptions

updateOptions(options: { enableHotKey?: boolean; enableUndoRedo?: boolean; mainCamera?: CameraComponent; multiSelect?: boolean; selectCondition?: (() => boolean); selectNull?: boolean; selectTags?: string; showGrid?: boolean; showHandle?: boolean; showOutline?: boolean }): void
更新选项
Parameters
- options: { enableHotKey?: boolean; enableUndoRedo?: boolean; mainCamera?: CameraComponent; multiSelect?: boolean; selectCondition?: (() => boolean); selectNull?: boolean; selectTags?: string; showGrid?: boolean; showHandle?: boolean; showOutline?: boolean }
  
  选项
  - Optional enableHotKey?: boolean
  - Optional enableUndoRedo?: boolean
  - Optional mainCamera?: CameraComponent
  - Optional multiSelect?: boolean
  - Optional selectCondition?: (() => boolean)
    - (): boolean
      
      Returns boolean
  - Optional selectNull?: boolean
  - Optional selectTags?: string
  - Optional showGrid?: boolean
  - Optional showHandle?: boolean
  - Optional showOutline?: boolean
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65

`Private` updateRecord

updateRecord(): void
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:1069

`Private` updateTransform

updateTransform(camera: CameraComponent): void
根据选中的物体，更新坐标轴的几何状态
Parameters
- camera: CameraComponent
  
  当前渲染相机
Returns void
- Defined in src/tools/runtimeTransformHandle/runtimeTransformHandle.ts:450

Class RuntimeTransformHandle

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: RTHOptions

Returns RuntimeTransformHandle

Properties

Private _selectedType

Private alignedCenterToCamVec

app

Private basePlaneDistance

Private centerPos

Private centerRot

Private centerToCamVec

Private deltaElr

Private deltaRotateMat

Private dragVec

Private entityRotationOffset

Private entitysRotationOffset

Private handleType

Private invertTransformMat

Private isDragging

Private orbitCamera

Private outLineCamera

Private outLineColor

Private pivotType

Private planeEdge1XEntity

Private planeEdge1YEntity

Private planeEdge1ZEntity

Private planeEdge2XEntity

Private planeEdge2YEntity

Private planeEdge2ZEntity

Private planeFollowNormal

Private planeHitVec

Private planeIntersectPoint

Private planeMoveNormal

Private planeOffset

Private planeOffsetVec

Private planeProject

Private planeToFollow

Private planeToMove

Private planeXAngle

Private planeXEntity

Private planeYAngle

Private planeYEntity

Private planeZAngle

Private planeZEntity

Private planesIntersectPoint

Private planesOffset

Private planesOffsetVec

Private record

Private rotateHandleScaler

Private rotationHandle

Private scaleHandle

Private scaleHandleScaler

Private screenVec

Private screenVec2

Private startRotateVec

Private startRotateVerticalVec

Private startScales

toolOptions

Protected toolOptionsDefault

Private trackEntities

Private trackTransforms

Private transformHandle

Private translationHandle

Private viewMat

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Private selectedType

`Private` _selectedType

`Private` alignedCenterToCamVec

`Private` basePlaneDistance

`Private` centerPos

`Private` centerRot

`Private` centerToCamVec

`Private` deltaElr

`Private` deltaRotateMat

`Private` dragVec

`Private` entityRotationOffset

`Private` entitysRotationOffset

`Private` handleType

`Private` invertTransformMat

`Private` isDragging

`Private` orbitCamera

`Private` outLineCamera

`Private` outLineColor

`Private` pivotType

`Private` planeEdge1XEntity

`Private` planeEdge1YEntity

`Private` planeEdge1ZEntity

`Private` planeEdge2XEntity

`Private` planeEdge2YEntity

`Private` planeEdge2ZEntity

`Private` planeFollowNormal

`Private` planeHitVec

`Private` planeIntersectPoint

`Private` planeMoveNormal

`Private` planeOffset

`Private` planeOffsetVec

`Private` planeProject

`Private` planeToFollow

`Private` planeToMove

`Private` planeXAngle

`Private` planeXEntity

`Private` planeYAngle

`Private` planeYEntity

`Private` planeZAngle

`Private` planeZEntity

`Private` planesIntersectPoint

`Private` planesOffset

`Private` planesOffsetVec

`Private` record

`Private` rotateHandleScaler

`Private` rotationHandle

`Private` scaleHandle

`Private` scaleHandleScaler

`Private` screenVec

`Private` screenVec2

`Private` startRotateVec

`Private` startRotateVerticalVec

`Private` startScales

`Protected` toolOptionsDefault

`Private` trackEntities

`Private` trackTransforms

`Private` transformHandle

`Private` translationHandle

`Private` viewMat

`Private` selectedType

`Protected` fire

`Optional` arg1: any

`Optional` arg2: any

`Optional` arg3: any

`Optional` arg4: any

`Optional` arg5: any

`Optional` arg6: any

`Optional` arg7: any

`Optional` arg8: any

`Optional` scope: object

`Optional` scope: object

`Private` onControlDown

`Private` onControlMove

`Private` onControlUp