phpOMS/Math/Shape/D2/Polygon.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.0
 *
 * @category   TBD
 * @package    TBD
 * @author     OMS Development Team <dev@oms.com>
 * @author     Dennis Eichhorn <d.eichhorn@oms.com>
 * @copyright  2013 Dennis Eichhorn
 * @license    OMS License 1.0
 * @version    1.0.0
 * @link       http://orange-management.com
 */
namespace phpOMS\Math\Shape\D2;

/**
 * Polygon class.
 *
 * @category   Framework
 * @package    phpOMS\Math
 * @author     OMS Development Team <dev@oms.com>
 * @author     Dennis Eichhorn <d.eichhorn@oms.com>
 * @license    OMS License 1.0
 * @link       http://orange-management.com
 * @since      1.0.0
 */
class Polygon implements D2ShapeInterface
{

    /**
     * Coordinates.
     *
     * These coordinates define the polygon
     *
     * @var array[]
     * @since 1.0.0
     */
    private $coord = [];

    /**
     * Polygon perimeter.
     *
     * @var float
     * @since 1.0.0
     */
    private $perimeter = 0.0;

    /**
     * Polygon surface.
     *
     * @var float
     * @since 1.0.0
     */
    private $surface = 0.0;

    /**
     * Interior angle sum of the polygon.
     *
     * @var int
     * @since 1.0.0
     */
    private $interiorAngleSum = 0;

    /**
     * Exterior angle sum of the polygon.
     *
     * @var float
     * @since 1.0.0
     */
    private $exteriorAngleSum = 0.0;

    /**
     * Polygon barycenter.
     *
     * @var float[]
     * @since 1.0.0
     */
    private $barycenter = ['x' => 0.0, 'y' => 0.0];

    /**
     * Polygon edge length.
     *
     * @var float
     * @since 1.0.0
     */
    private $edgeLength = 0.0;

    /**
     * Polygon inner length.
     *
     * @var float
     * @since 1.0.0
     */
    private $innerLength = 0.0;

    /**
     * Polygon inner edge angular.
     *
     * @var int
     * @since 1.0.0
     */
    private $innerEdgeAngular = 0;

    /**
     * Constructor.
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function __construct()
    {
    }

    /**
     * Point polygon relative position
     *
     * @param array $point Point location
     *
     * @return int
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public static function pointInPolygon(array $point) : int
    {
        $length = count($this->coord);

        // Polygon has to start and end with same point
        if ($this->coord[0]['x'] !== $this->coord[$length - 1]['x'] || $this->coord[0]['y'] !== $this->coord[$length - 1]['y']) {
            $this->coord[] = $this->coord[0];
        }

        // On vertex?
        if (self::isOnVertex($point, $this->coord)) {
            return 0;
        }

        // Inside or ontop?
        $countIntersect    = 0;
        $this->coord_count = count($this->coord);

        // todo: return based on highest possibility not by first match
        for ($i = 1; $i < $this->coord_count; $i++) {
            $vertex1 = $this->coord[$i - 1];
            $vertex2 = $this->coord[$i];

            if (abs($vertex1['y'] - $vertex2['y']) < self::EPSILON && abs($vertex1['y'] - $point['y']) < self::EPSILON && $point['x'] > min($vertex1['x'], $vertex2['x']) && $point['x'] < max($vertex1['x'], $vertex2['x'])) {
                return 0; // boundary
            }

            if ($point['y'] > min($vertex1['y'], $vertex2['y']) && $point['y'] <= max($vertex1['y'], $vertex2['y']) && $point['x'] <= max($vertex1['x'], $vertex2['x']) && abs($vertex1['y'] - $vertex2['y']) >= self::EPSILON) {
                $xinters = ($point['y'] - $vertex1['y']) * ($vertex2['x'] - $vertex1['x']) / ($vertex2['y'] - $vertex1['y']) + $vertex1['x'];

                if (abs($xinters - $point['x']) < self::EPSILON) {
                    return 0; // boundary
                }

                if (abs($vertex1['x'] - $vertex2['x']) < self::EPSILON || $point['x'] < $xinters) {
                    $countIntersect++;
                }
            }
        }

        if ($countIntersect % 2 != 0) {
            return -1;
        }

        return 1;
    }

    /**
     * Is point on vertex?
     *
     * @param array $point Point location
     *
     * @return bool
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    private static function isOnVertex(array $point) : bool
    {
        foreach ($this->coord as $vertex) {
            if (abs($point['x'] - $vertex['x']) < self::EPSILON && abs($point['y'] - $vertex['y']) < self::EPSILON) {
                return true;
            }
        }

        return false;
    }

    /**
     * Set polygon coordinates.
     *
     * @param array[] $coord Coordinates
     *
     * @return void
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function setCoordinates($coord)
    {
        $this->coord = $coord;
    }

    /**
     * Set polygon coordinate.
     *
     * @param int       $i Index
     * @param int|float $x X coordinate
     * @param int|float $y Y coordinate
     *
     * @return void
     *
     * @since  1.0.0
     * @author Dennis Eichhorn <d.eichhorn@oms.com>
     */
    public function setCoordinate($i, $x, $y)
    {
        $this->coord[$i] = ['x' => $x, 'y' => $y];
    }

    /**
     * {@inheritdoc}
     */
    public function getInteriorAngleSum() : int
    {
        $this->interiorAngleSum = (count($this->coord) - 2) * 180;

        return $this->interiorAngleSum;
    }

    /**
     * {@inheritdoc}
     */
    public function getExteriorAngleSum()
    {
        return 360;
    }

    /**
     * {@inheritdoc}
     */
    public function getInteriorAngleSumFormula()
    {
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function getExteriorAngleSumFormula()
    {
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function getSurface() : float
    {
        $this->surface = 0.0;
        $count         = count($this->coord);

        for ($i = 0; $i < $count - 2; $i++) {
            $this->surface += $this->coord[$i]['x'] * $this->coord[$i + 1]['y'] - $this->coord[$i + 1]['x'] * $this->coord[$i]['y'];
        }

        $this->surface /= 2;
        $this->surface = abs($this->surface);

        return $this->surface;
    }

    /**
     * {@inheritdoc}
     */
    public function setSurface($surface)
    {
        $this->reset();

        $this->surface = $surface;
    }

    /**
     * {@inheritdoc}
     */
    public function reset()
    {
        $this->coord            = [];
        $this->barycenter       = ['x' => 0.0, 'y' => 0.0];
        $this->perimeter        = 0.0;
        $this->surface          = 0.0;
        $this->interiorAngleSum = 0;
        $this->edgeLength       = 0.0;
        $this->innerLength      = 0.0;
        $this->innerEdgeAngular = 0;
    }

    /**
     * {@inheritdoc}
     */
    public function getSurfaceFormula()
    {
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function getPerimeter()
    {
        $count           = count($this->coord);
        $this->perimeter = sqrt(($this->coord[0]['x'] - $this->coord[$count - 1]['x']) ** 2 + ($this->coord[0]['y'] - $this->coord[$count - 1]['y']) ** 2);

        for ($i = 0; $i < $count - 2; $i++) {
            $this->perimeter += sqrt(($this->coord[$i + 1]['x'] - $this->coord[$i]['x']) ** 2 + ($this->coord[$i + 1]['y'] - $this->coord[$i]['y']) ** 2);
        }

        return $this->perimeter;
    }

    /**
     * {@inheritdoc}
     */
    public function setPerimeter($perimeter)
    {
        $this->reset();

        $this->perimeter = $perimeter;
    }

    /**
     * {@inheritdoc}
     */
    public function getPerimeterFormula()
    {
        return '';
    }

    /**
     * {@inheritdoc}
     */
    public function getBarycenter()
    {
        $this->barycenter['x'] = 0;
        $this->barycenter['y'] = 0;

        $count = count($this->coord);

        for ($i = 0; $i < $count - 2; $i++) {
            $mult = ($this->coord[$i]['x'] * $this->coord[$i + 1]['y'] - $this->coord[$i + 1]['x'] * $this->coord[$i]['y']);
            $this->barycenter['x'] += ($this->coord[$i]['x'] + $this->coord[$i + 1]['x']) * $mult;
            $this->barycenter['y'] += ($this->coord[$i]['y'] + $this->coord[$i + 1]['y']) * $mult;
        }

        return $this->barycenter;
    }
}