huzhihao/sat

A library performing collision detection of simple 2D shapes with Separating Axis Theorem.

dev-master 2024-03-22 02:28 UTC

Requires

• php: >=5.3.0

MIT

• huzhihao

• sat
• 2d
• collision
• Separating Axis Theorem

README

A library performing collision detection of simple 2D shapes with Separating Axis Theorem.

Simply translated from a Javascript library and reconstructed into a PHP version.

Requirements

• PHP version 5.3.0 or higher

Installation

composer require huzhihao/sat:dev-master and then require the Composer autoloader from your code.

Usage

Here are the examples to show how SAT works. To check whether two shapes collide, you can use SAT\Collision::XXX functions. And a Response object will be given to check whether one shape is completely covered by the other.

<?php
use SAT\Entity\Circle;
use SAT\Entity\Polygon;
use SAT\Entity\Response;
use SAT\Entity\Vector;
use SAT\Collision;

function dumpR(Response $r){
    echo "overlap:{$r->overlap} overlapV:[{$r->overlapV->x},{$r->overlapV->y}] overlapN:[{$r->overlapN->x},{$r->overlapN->y}] aInB:".($r->aInB?1:0)." bInA:".($r->bInA?1:0)."\n";
}

//pointInCircle
$point = new Vector(1, 1);
$circle = new Circle(new Vector(1, 1), 1);
var_dump(Collision::pointInCircle($point, $circle));

$point = new Vector(1, 2.1);
$circle = new Circle(new Vector(1, 1), 1);
var_dump(Collision::pointInCircle($point, $circle));

//pointInPolygon
$point = new Vector(1, 2.1);
$polygon = new Polygon(null, array(new Vector(3,1), new Vector(3,2), new Vector(2,3), new Vector(1,2),new Vector(1,1),new Vector(2,0)));
var_dump(Collision::pointInPolygon($point, $polygon));

$polygon = new Polygon(new Vector(-1,-1),array(new Vector(1,1),new Vector(1.5,1.5),new Vector(2,1),new Vector(2,2),new Vector(3,2),new Vector(1.5,4),new Vector(1,3),new Vector(1.5,3)));
$point = new Vector(1, 2);
var_dump(Collision::pointInPolygon($point, $polygon));
$point = new Vector(1, 2.5);
var_dump(Collision::pointInPolygon($point, $polygon));

//testCircleCircle
$c1 = new Circle(new Vector(1, 1), 1);
$c2 = new Circle(new Vector(2, 2), 1);
$r = new Response();
var_dump(Collision::testCircleCircle($c1, $c2, $r));
dumpR($r);
$c3 = new Circle(new Vector(3, 1), 0.9);
var_dump(Collision::testCircleCircle($c1, $c3, $r));

$c4 = new Circle( new Vector(0.9,1), 0.1);
var_dump(Collision::testCircleCircle($c1, $c4, $r));
dumpR($r);

//testPolygonCircle
$p1 = new Polygon(new Vector(-1, 0), array(new Vector(3,1), new Vector(3,2), new Vector(2,3), new Vector(1,2),new Vector(1,1),new Vector(2,0)));
$c1 = new Circle(new Vector(0,0), 1/sqrt(2));
$r->clear();
var_dump(Collision::testPolygonCircle($p1, $c1, $r));
dumpR($r);

$c2 = new Circle(new Vector(-0.1,0), 1/sqrt(2));
var_dump(Collision::testPolygonCircle($p1, $c2, $r));

$r->clear();
$c3 = new Circle(new Vector(1,1.5), 1);
var_dump(Collision::testPolygonCircle($p1, $c3, $r));
dumpR($r);

//testCirclePolygon
$r->clear();
var_dump(Collision::testCirclePolygon($c1, $p1, $r));
dumpR($r);

$r->clear();
var_dump(Collision::testCirclePolygon($c3, $p1, $r));
dumpR($r);

$c4 = new Circle(new Vector(1, 1.5), 1.5);
$r->clear();
var_dump(Collision::testCirclePolygon($c4, $p1, $r));
dumpR($r);

//testPolygonPolygon
$p1 = new Polygon(new Vector(-1, 0), array(new Vector(3,1), new Vector(3,2), new Vector(2,3), new Vector(1,2),new Vector(1,1),new Vector(2,0)));
$p2 = new Polygon(new Vector(-0.5, 0.5), array(new Vector(3,1), new Vector(3,2), new Vector(2,3), new Vector(1,2),new Vector(1,1),new Vector(2,0)));
$r->clear();
var_dump(Collision::testPolygonPolygon($p1, $p2, $r));
dumpR($r);

P.S.

For more details such as the properties of each class, please read the original Javascript library's document.