Resolv: 简单实用的Go语言2D碰撞检测函数库

代码仓库介绍
仓库地址： https://github.com/SolarLune/resolv

1. 背景介绍

• 项目简介：Resolv 是一个 2D 碰撞检测和解析库，核心概念相当简单，可以轻松适应其他语言或游戏开发框架（比如 ebiten ）。
• 编程语言：Go 语言
• 使用场景：专为更简单的“街机”视频游戏而创建，不适用于需要使用真实物理效果的项目。（比如模拟重力等）

注：“解析”按照作者的说法是解析碰撞，根据作者给出的案例来看，应该是能够解析出物体的碰撞点。

实例演示：（可以从源代码库的 examples目录中获取示例代码）

2. 如何使用

• 获取：

go get github.com/solarlune/resolv

• 代码示例

例子1：在一个空间中 (space)，玩家(player) 均速向右移动，直到碰到不能穿过的物体。
在这个例子中，首先创建空间 Space 对象，并创建各种物体（玩家，墙壁等），将这些物体加入到此空间中，在 Update 函数中每帧去检测玩家是否与空间中的其他物体有碰撞，并移动玩家，最后更新玩家的位置。

var space *resolv.Space // 空间
var playerObj *resolv.Object // 玩家对象

// 例如，在游戏或关卡启动时的初始化函数中...
func Init() {
    
    // 创建一个空间，玩家角色、敌人和可收集物品都会被加入这个空间中
    space = resolv.NewSpace(640, 480, 16, 16)
    
    // 向 Space 中添加对象
    space.Add(
        resolv.NewObject(0, 0, 640, 16),
        resolv.NewObject(0, 480-16, 640, 16),
        resolv.NewObject(0, 16, 16, 480-32),
        resolv.NewObject(640-16, 16, 16, 480-32),
    )

    // 初始化玩家对象
    playerObj = resolv.NewObject(32, 32, 16, 16)

    // 向 Space 中添加玩家对象
    space.Add(playerObj)

}

// 接下来，在游戏的更新循环中，每帧运行一次...
func Update() {

    // 将玩家每帧向右移动2个像素
    dx := 2.0

    // 检测玩家是否将要与自身2个像素周围的物体； 
    // Check 方法可以传入物体的标签，仅与有该标签的物体进行碰撞检测。
    if collision := playerObj.Check(dx, 0); collision != nil {
        // 如果发生碰撞，玩家就不能继续向右移动2个像素，否则将会和物体碰撞。
        // 具体能够移动的距离可以利用 ContactWithObject 来获取
        dx = collision.ContactWithObject(collision.Objects[0]).X()
    }

    // 玩家向右移动 dx
    playerObj.X += dx

    // 更新玩家的位置信息
    playerObj.Update()
}

例子2：本例中玩家向一个斜坡所在方向进行移动，然后检查它们之间是否相交来进行更准确的形状相交测试。在内部检查形状相交时，执行分离轴定理（SAT）碰撞测试（当与凸多边形相交测试时），这代表了 Resolv 更低效的窄相位部分。如果可以不进行基于形状的相交测试（不需要求交点），那么最好不要这样做，因为这会是最高效的。

var playerObj *resolv.Object
var stairs *resolv.Object // 斜梯
var space *resolv.Space

func init() {

	space = resolv.NewSpace(640, 480, 16, 16)

	// 创建玩家对象，并设置形状为矩形（也支持自定义形状，需要提供图形的顺时针顶点坐标）
	playerObj = resolv.NewObject(32, 128, 16, 16)
	playerObj.SetShape(resolv.NewRectangle(0, 0, 16, 16))
    
	space.Add(playerObj)
    
    // 添加阶梯:需要顺时针传入多边形的顶点的坐标
	stairs = resolv.NewObject(96, 128, 16, 16)
	stairs.SetShape(resolv.NewConvexPolygon( // 注意：这里可以调整顶点坐标以改变斜梯的方向
		0, 0,   // 多边形的坐标
		16, 0,  // 第一个顶点坐标
		16, 16, // 第二个顶点坐标
		0, 16,  // 最后一个顶点的坐标
	))
    
	space.Add(stairs)
}

func Update() {
    // 玩家移动距离
	dx := 1.0

    // 检测两个多边形的交点（这里就是玩家和阶梯的交点）
	if intersection := playerObj.Shape.Intersection(dx, 0, stairs.Shape); intersection != nil {

        // 得到 MTV（最小平移矢量）,根据这个值来移动
		dx = intersection.MTV.X
        // 这里可以将移动的幅度 dx 比增量小一点(比如0.1) 避免“弹跳”；
        // 也可以利用MTV，计算可以玩家应该如何在斜面上移动
	}

	playerObj.Position.X += dx

	playerObj.Update()

}

3. 待改进的内容

• 允许单元格小于1个单位大小（因此，Space 可以具有例如0.1单位大小的单元格）
• 为了提高速度、一致性，并减少第三方导入，使用自定义向量结构
• 交点最小移动量（MTV）在外部法线上的多边形上能够正常工作，但在内部法线上不能正常工作。

4. 活跃程度

• Star 趋势图：https://star-history.com/#SolarLune/resolv&Date

注意：resolv 库仍然在开发中，但应该在实际场景中足够稳定。