Class RTH_RuntimeGrid

Hierarchy

Tool<RuntimeGridOptions, any>
- RTH_RuntimeGrid

Index

Constructors

constructor

new RTH_RuntimeGrid(options: RuntimeGridOptions): RTH_RuntimeGrid
Parameters
- options: RuntimeGridOptions
Returns RTH_RuntimeGrid
Overrides Tool.constructor
- Defined in src/tools/runtimeTransformHandle/features/runtimeGrid.ts:42

Properties

app

app: AppBase

`Private` grid

grid: Entity

toolOptions

toolOptions: RuntimeGridOptions

`Protected` toolOptionsDefault

toolOptionsDefault: RuntimeGridOptions = ...

`Static` `Private` _layer

_layer: Layer

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

`Static` layer

get layer(): Layer
Returns Layer
- Defined in src/tools/runtimeTransformHandle/features/runtimeGrid.ts:29

Methods

`Private` createGrid

createGrid(w: number, h: number, wd??: number, hd??: number, color?: Color): Entity
创建grid

Returns
grid
Parameters
- w: number
  
  grid宽度
- h: number
  
  grid高度
- Optional wd: number = w
  
  grid宽维度
- Optional hd: number = h
  
  grid高维度
- color: Color = pc.Color.BLACK
Returns Entity
- Defined in src/tools/runtimeTransformHandle/features/runtimeGrid.ts:83

`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 string | number | symbol
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

hasEvent

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

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

off

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

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

on

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

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

`Protected` onDisable

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

`Protected` onEnable

onEnable(): void
Returns void
Inherited from Tool.onEnable
- Defined in src/utils/helpers/toolBase.ts:133

once

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

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

setOptions

setOptions(options: RuntimeGridOptions): void
设置RuntimeGrid选项
Parameters
- options: RuntimeGridOptions
  
  RuntimeGrid选项
Returns void
Overrides Tool.setOptions
- Defined in src/tools/runtimeTransformHandle/features/runtimeGrid.ts:59

updateOptions

updateOptions(options: { mainCamera?: CameraComponent; range?: Vec2 }): void
更新选项
Parameters
- options: { mainCamera?: CameraComponent; range?: Vec2 }
  
  选项
  - Optional mainCamera?: CameraComponent
  - Optional range?: Vec2
Returns void
Inherited from Tool.updateOptions
- Defined in src/utils/helpers/toolBase.ts:65

Class RTH_RuntimeGrid

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: RuntimeGridOptions

Returns RTH_RuntimeGrid

Properties

app

Private grid

toolOptions

Protected toolOptionsDefault

Static Private _layer

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Static layer

Returns Layer

Methods

Private createGrid

Returns

Parameters

w: number

h: number

Optional wd: number = w

Optional hd: number = h

color: Color = pc.Color.BLACK

Returns Entity

Protected fire

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

Optional arg1: any

Optional arg2: any

Optional arg3: any

Optional arg4: any

Optional arg5: any

Optional arg6: any

Optional arg7: any

Optional arg8: any

Returns EventHandler

hasEvent

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

Returns boolean

off

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

linstener: any

Optional scope: object

Returns EventHandler

on

Returns

Type Parameters

EventName extends string | number | symbol

Parameters

eventName: EventName

linstener: any

Optional scope: object

Returns EventHandler

Protected onDisable

Returns void

Protected onEnable

Returns void

`Private` grid

`Protected` toolOptionsDefault

`Static` `Private` _layer

`Static` layer

`Private` createGrid

`Optional` wd: number = w

`Optional` hd: number = h

`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

`Protected` onDisable

`Protected` onEnable

`Optional` scope: object

`Optional` mainCamera?: CameraComponent

`Optional` range?: Vec2