Class OutlineCamera

Hierarchy

Tool<outlineCameraOptions, any>
- OutlineCamera

Index

Constructors

constructor

new OutlineCamera(options?: outlineCameraOptions): OutlineCamera
Parameters
- Optional options: outlineCameraOptions
Returns OutlineCamera
Overrides Tool.constructor
- Defined in src/tools/camera/outlineCamera.ts:51

Properties

app

app: AppBase

`Private` outlineCamera

outlineCamera: CameraComponent

`Private` outlineEffect

outlineEffect: PostEffectOutline

`Private` outlineLayer

outlineLayer: Layer

toolOptions

toolOptions: outlineCameraOptions

`Protected` toolOptionsDefault

toolOptionsDefault: outlineCameraOptions = ...

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

Methods

`Private` createRenderTarget

createRenderTarget(): RenderTarget
创建大小为整个屏幕的renderTarget（用于后期）

Returns
可以覆盖整个屏幕的renderTarget

Returns RenderTarget
- Defined in src/tools/camera/outlineCamera.ts:152

`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

`Private` initEffect

initEffect(option?: { color: Color; thickness: number }): void
初始化后期特效
Parameters
- Optional option: { color: Color; thickness: number }
  
  描边设置
  - color: Color
    
    描边颜色
  - thickness: number
    
    描边粗细
Returns void
- Defined in src/tools/camera/outlineCamera.ts:110

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/camera/outlineCamera.ts:193

`Protected` onEnable

onEnable(): void
Returns void
Overrides Tool.onEnable
- Defined in src/tools/camera/outlineCamera.ts:188

`Private` onResize

onResize(): void
窗口缩放时调用

Returns void
- Defined in src/tools/camera/outlineCamera.ts:183

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

`Private` resetEffect

resetEffect(): void
重设特效，一般为窗口大小改变时调用

Returns void
- Defined in src/tools/camera/outlineCamera.ts:174

setOptions

setOptions(options: outlineCameraOptions): void
设置外边框相机选项
Parameters
- options: outlineCameraOptions
  
  外边框相机选项
Returns void
Overrides Tool.setOptions
- Defined in src/tools/camera/outlineCamera.ts:61

toggleOutLine

toggleOutLine(entity: Entity, isOn: boolean): void
开启或关闭描边特效
Parameters
- entity: Entity
  
  节点
- isOn: boolean
Returns void
- Defined in src/tools/camera/outlineCamera.ts:84

updateOptions

updateOptions(options: outlineCameraOptions): void
更新外边框相机选项
Parameters
- options: outlineCameraOptions
  
  外边框相机选项
Returns void
Overrides Tool.updateOptions
- Defined in src/tools/camera/outlineCamera.ts:72

Class OutlineCamera

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: outlineCameraOptions

Returns OutlineCamera

Properties

app

Private outlineCamera

Private outlineEffect

Private outlineLayer

toolOptions

Protected toolOptionsDefault

Accessors

enabled

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private createRenderTarget

Returns

Returns RenderTarget

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

Private initEffect

Parameters

Optional option: { color: Color; thickness: number }

color: Color

thickness: number

Returns void

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 onResize

`Optional` options: outlineCameraOptions

`Private` outlineCamera

`Private` outlineEffect

`Private` outlineLayer

`Protected` toolOptionsDefault

`Private` createRenderTarget

`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

`Private` initEffect

`Optional` option: { color: Color; thickness: number }

`Optional` scope: object

`Optional` scope: object

`Protected` onDisable

`Protected` onEnable

`Private` onResize

`Optional` scope: object

`Private` resetEffect