DVDoug\BoxPacker\OrientatedItem

Complexity

Total Complexity

8

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Test Coverage

Coverage

90.48%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getTippingPoint()	0	3	1
A	getDepth()	0	3	1
A	getWidth()	0	3	1
A	__construct()	0	7	1
A	getLength()	0	3	1
A	getSurfaceFootprint()	0	3	1
A	isStable()	0	3	1
A	getItem()	0	3	1

<?php
/**
 * Box packing (3D bin packing, knapsack problem).
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace DVDoug\BoxPacker;

use function min;

/**
 * An item to be packed.
 *
 * @author Doug Wright
 */
class OrientatedItem
{
    /**
     * @var Item
     */
    protected $item;

    /**
     * @var int
     */
    protected $width;

    /**
     * @var int
     */
    protected $length;

    /**
     * @var int
     */
    protected $depth;

    /** @var float */
    protected $tippingPoint;

    /**
     * Constructor.
     *
     * @param Item $item
     * @param int  $width
     * @param int  $length
     * @param int  $depth
     */
    public function __construct(Item $item, int $width, int $length, int $depth)
    {
        $this->item = $item;
        $this->width = $width;
        $this->length = $length;
        $this->depth = $depth;
        $this->tippingPoint = atan(min($this->length, $this->width) / $this->depth);
    }

    /**
     * Item.
     *
     * @return Item
     */
    public function getItem(): Item
    {
        return $this->item;
    }

    /**
     * Item width in mm in it's packed orientation.
     *
     * @return int
     */
    public function getWidth(): int
    {
        return $this->width;
    }

    /**
     * Item length in mm in it's packed orientation.
     *
     * @return int
     */
    public function getLength(): int
    {
        return $this->length;
    }

    /**
     * Item depth in mm in it's packed orientation.
     *
     * @return int
     */
    public function getDepth(): int
    {
        return $this->depth;
    }

    /**
     * Calculate the surface footprint of the current orientation.
     *
     * @return int
     */
    public function getSurfaceFootprint(): int
    {
        return $this->width * $this->length;
    }

    /**
     * @return float
     */
    public function getTippingPoint(): float
    {
        return $this->tippingPoint;
    }

    /**
     * Is this item stable (low centre of gravity), calculated as if the tipping point is >15 degrees.
     *
     * N.B. Assumes equal weight distribution.
     *
     * @return bool
     */
    public function isStable(): bool
    {
        return $this->tippingPoint > 0.261;
    }
}