Class Collision

Example: 示例

const collision = new Collision({
     shape: Collision.rectShape(0, 0, 12, 10)
})
collision.onBodyEnter=(res)=>{} // 其他物理体进入
collision.onBodyExit=(res)=>{} // 其他物理体离开
collision.onClick=()=>{} //被点击
// 以上上个均可以用事件连接

该节点的事件，请查看：ICollisionEvent

Hierarchy (view full)

Transform2D
- Collision

Constructors

constructor

new Collision(options): Collision
Parameters
- options: ICollisionOptions
Returns Collision
Overrides Transform2D.constructor
- Defined in nodes/collision.ts:27

Properties

ShapePosition

ShapePosition: Vector2[] = []

children

children: Container[] = []

子节点列表

collisions

collisions: Collision[] = []

destroyed

destroyed: boolean = false

是否被销毁

`Protected` engine

engine: SparkleEngine

event

event: EventEmitter<ICollisionEvent>

`Readonly` globalPosition

globalPosition: Vector2 = ...

全局坐标

`Readonly` globalRotation

globalRotation: number = 0

全局旋转

inTree

inTree: boolean = false

是否在场景树中

`Protected` isReady

isReady: boolean = false

是否已就绪

offset

offset: Vector2

偏移

`Optional` parent

parent?: null | Container

父节点

physics

physics: PhysicsManager

pool

pool: PoolManager

对于对象池的引用

position

position: Vector2

坐标，坐标是相对于父的。若要设置全局坐标，请使用globalPosition

`Protected` renderer

renderer: Renderer

resident

resident: boolean

是否为常驻节点，如果是常驻节点的话在切换场景时不会被销毁（其子节点同样不会被销毁）注意：常驻节点必须是根节点的一级子节点

results

results: ICollisionResult[] = []

rotation

rotation: number

旋转，旋转是相对于父的。若要设置全局旋转，请使用globalRotation

scale

scale: Vector2

缩放，缩放同样是相对父的

shape

shape: Vector2[] = []

skew

skew: Vector2

斜切

tag

tag: Set<string>

Tag 用于节点查找，可以有多个tag

Accessors

root

get root(): Container
Returns Container
Inherited from Transform2D.root
- Defined in nodes/container.ts:59

Methods

addChild

addChild<T>(child): T
添加一个子节点
Type Parameters
- T extends Container
Parameters
- child: T
Returns T
Inherited from Transform2D.addChild
- Defined in nodes/container.ts:122

clearShape

clearShape(): void
Returns void
- Defined in nodes/collision.ts:118

collisionDetection

collisionDetection(): ICollisionResult[]
检测碰撞，一般不需要手动调用

Returns ICollisionResult[]
- Defined in nodes/collision.ts:69

destory

destory(): void
销毁这个节点

Returns void
Inherited from Transform2D.destory
- Defined in nodes/container.ts:387

doDestory

doDestory(): void
Returns void
Overrides Transform2D.doDestory
- Defined in nodes/collision.ts:128

draw

draw(): void
Returns void
Overrides Transform2D.draw
- Defined in nodes/collision.ts:102

drawDebug

drawDebug(): void
Returns void
Overrides Transform2D.drawDebug
- Defined in nodes/collision.ts:112

findAllByTag

findAllByTag(tag, deep?): Container[]
根据tag查找子节点
Parameters
- tag: string | string[]
  要查找的tag（支持多个）
- deep: boolean = true
Returns Container[]
找到的子节点数组
Inherited from Transform2D.findAllByTag
- Defined in nodes/container.ts:332

findByTag

findByTag(tag, deep?): null | Container
Parameters
- tag: string | string[]
- deep: boolean = true
Returns null | Container
Inherited from Transform2D.findByTag
- Defined in nodes/container.ts:346

getMouseGlobalPositon

getMouseGlobalPositon(): Vector2
获取鼠标的全局位置

Returns Vector2
Inherited from Transform2D.getMouseGlobalPositon
- Defined in nodes/transform_2d.ts:58

getMouseLocalPositon

getMouseLocalPositon(): Vector2
获取鼠标相对于我的位置

Returns Vector2
Inherited from Transform2D.getMouseLocalPositon
- Defined in nodes/transform_2d.ts:51

isChild

isChild(child): boolean
判断节点是不是子节点（包括所有子孙节点）
Parameters
- child: Container
Returns boolean
Inherited from Transform2D.isChild
- Defined in nodes/container.ts:207

isParent

isParent(parent): boolean
判断节点是不是父节点（包括所有祖辈节点）
Parameters
- parent: Container
Returns boolean
Inherited from Transform2D.isParent
- Defined in nodes/container.ts:188

mouseDetection

mouseDetection(): boolean
Returns boolean
- Defined in nodes/collision.ts:72

offEvent

offEvent<T>(obj, eventName, func): void
使用该方法取消 onEvent 监听的事件
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
- func: T[keyof T]
Returns void
Inherited from Transform2D.offEvent
- Defined in nodes/container.ts:99

onBodyEnter

onBodyEnter(_res): void
Parameters
- _res: ICollisionResult
Returns void
- Defined in nodes/collision.ts:99

onBodyExit

onBodyExit(_body): void
Parameters
- _body: Collision
Returns void
- Defined in nodes/collision.ts:100

onClick

onClick(): void
Returns void
- Defined in nodes/collision.ts:98

onEnterTree

onEnterTree(): void
当进入场景树时被调用

Returns void
Inherited from Transform2D.onEnterTree
- Defined in nodes/container.ts:297

onEvent

onEvent<T>(obj, eventName, func): void
使用该种方法监听事件，当节点被销毁时自动取消监听
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
- func: T[keyof T]
Returns void
Inherited from Transform2D.onEvent
- Defined in nodes/container.ts:81

onExitTree

onExitTree(): void
当离开场景树时被调用

Returns void
Inherited from Transform2D.onExitTree
- Defined in nodes/container.ts:301

`Private` onMouseClick

onMouseClick(): void
Returns void
- Defined in nodes/collision.ts:92

onUpdate

onUpdate(_dt): void
每一帧调用
Parameters
- _dt: number
Returns void
Inherited from Transform2D.onUpdate
- Defined in nodes/container.ts:311

removeChild

removeChild(child): void
移除一个子节点
Parameters
- child: Container
Returns void
Inherited from Transform2D.removeChild
- Defined in nodes/container.ts:159

removeFromParent

removeFromParent(): void
从父节点中移除当前节点

Returns void
Inherited from Transform2D.removeFromParent
- Defined in nodes/container.ts:149

setParent

setParent(parent): void
设置父节点如果当前节点已经有父节点，则先从原来的父节点中移除
Parameters
- parent: Container
Returns void
Inherited from Transform2D.setParent
- Defined in nodes/container.ts:131

setParentIndex

setParentIndex(index): void
设置所在的父节点的子排序
Parameters
- index: number
Returns void
Inherited from Transform2D.setParentIndex
- Defined in nodes/container.ts:172

setShape

setShape(shape): void
Parameters
- shape: Vector2[]
Returns void
- Defined in nodes/collision.ts:58

traverseChildren

traverseChildren(fn): any
遍历所有子节点
Parameters
- fn: ((child) => any)
  应用到每个子节点的函数。如果函数返回非false值，则停止遍历。
  - - (child): any
    - Parameters
      child: Container
      Returns any
Returns any
如果任何fn调用返回了非false值，则返回该值；否则返回false。
Inherited from Transform2D.traverseChildren
- Defined in nodes/container.ts:366

update

update(dt): void
Parameters
- dt: number
Returns void
Overrides Transform2D.update
- Defined in nodes/collision.ts:34

waitEvent

waitEvent<T>(obj, eventName): Promise<unknown>
等待某个事件被触发，想实现等待1秒，那么就用该方法等待timer的事件
Type Parameters
- T extends Record<string, any>
Parameters
- obj: IEventAble<T>
- eventName: keyof T
Returns Promise<unknown>
Inherited from Transform2D.waitEvent
- Defined in nodes/container.ts:112

`Static` rectShape

rectShape(x, y, width, height): Vector2[]
Parameters
- x: number
- y: number
- width: number
- height: number
Returns Vector2[]
- Defined in nodes/collision.ts:132

Class Collision

Example: 示例

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ICollisionOptions

Returns Collision

Properties

ShapePosition

children

collisions

destroyed

Protected engine

event

Readonly globalPosition

Readonly globalRotation

inTree

Protected isReady

offset

Optional parent

physics

pool

position

Protected renderer

resident

results

rotation

scale

shape

skew

tag

Accessors

root

Returns Container

Methods

addChild

Type Parameters

T extends Container

Parameters

child: T

Returns T

clearShape

Returns void

collisionDetection

Returns ICollisionResult[]

destory

Returns void

doDestory

Returns void

draw

Returns void

drawDebug

Returns void

findAllByTag

Parameters

tag: string | string[]

deep: boolean = true

Returns Container[]

findByTag

Parameters

tag: string | string[]

deep: boolean = true

Returns null | Container

getMouseGlobalPositon

Returns Vector2

getMouseLocalPositon

Returns Vector2

isChild

Parameters

child: Container

Returns boolean

isParent

Parameters

parent: Container

`Protected` engine

`Readonly` globalPosition

`Readonly` globalRotation

`Protected` isReady

`Optional` parent

`Protected` renderer

`Private` onMouseClick