php3d\stl\STL

Complexity

Total Complexity

17

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getSolidName()	0	4	1
A	setSolidName()	0	5	1
A	__construct()	0	3	1
B	fromString()	0	26	3
A	fromArray()	0	11	2
A	addFacetNormal()	0	5	1
A	getFacetNormalCount()	0	4	1
A	getFacetNormal()	0	4	1
A	setFacetNormal()	0	5	1
A	deleteFacetNormal()	0	7	1
A	toArray()	0	14	2
A	toString()	0	14	2

<?php
/*
 * This file is part of the STL package.
 *
 * (c) Grosan Flaviu Gheorghe <fgheorghe@grosan.co.uk>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace php3d\stl;

/**
 * Class STL. Provides functionality for parsing STL files.
 * @package php3d\stl
 */
class STL
{
    /**
     * @var string
     */
    private $solidName;

    /**
     * @var array
     */
    private $facets = array();

    /**
     * @return string
     */
    public function getSolidName(): string
    {
        return $this->solidName;
    }

    /**
     * @param string $solidName
     * @return STL
     */
    public function setSolidName(string $solidName): STL
    {
        $this->solidName = $solidName;
        return $this;
    }

    // Class should never be instantiated directly, as it emulates constructor overloading.
    private function __construct()
    {
    }

    /**
     * Class constructor from an STL string.
     *
     * Example STL file string: see STLTest $stlFileString property.
     *
     * @param string $stlFileContentString
     * @return STL
     */
    public static function fromString(string $stlFileContentString) : STL
    {
        $class = new self();

        // Extract name.
        $lines = explode("\n", $stlFileContentString);
        preg_match("/solid (.+)/", $lines[0], $matches);
        $class->setSolidName($matches[1]);

        // Extract facets.
        foreach ($lines as $line) {
            if (preg_match("/facet normal (.+)/", $line)) {
                // Get this line and the following, making a block of facets.
                $string = next($lines) . "\n";
                $string .= next($lines) . "\n";
                $string .= next($lines) . "\n";
                $string .= next($lines) . "\n";
                $string .= next($lines) . "\n";
                $string .= next($lines) . "\n";
                $string .= next($lines) . "\n";
                $class->addFacetNormal(STLFacetNormal::fromString($string));
            }
        }

        return $class;
    }

    /**
     * Class constructor from an STL array.
     *
     * Example STL file array: see STLTest $stlFileArray property.
     *
     * @param array $stlFileArray
     * @return STL
     */
    public static function fromArray(array $stlFileArray) : STL
    {
        $class = new self();

        $class->setSolidName($stlFileArray["name"]);
        foreach ($stlFileArray["facets"] as $facet) {
            $class->addFacetNormal(STLFacetNormal::fromArray($facet));
        }

        return $class;
    }

    /**
     * Adds a new facet normal object.
     *
     * @param STLFacetNormal $facetNormal
     * @return STL
     */
    public function addFacetNormal(STLFacetNormal $facetNormal) : STL
    {
        $this->facets[] = $facetNormal;
        return $this;
    }

    /**
     * Returns the number of facets in this STL object.
     *
     * @return int
     */
    public function getFacetNormalCount() : int
    {
        return count($this->facets);
    }

    /**
     * Returns facet normal object at position.
     *
     * @param int $position
     * @return STLFacetNormal
     */
    public function getFacetNormal(int $position) : STLFacetNormal
    {
        return $this->facets[$position];
    }

    /**
     * Sets a facet normal at a given position.
     *
     * @param int $position
     * @param STLFacetNormal $facetNormal
     * @return STL
     */
    public function setFacetNormal(int $position, STLFacetNormal $facetNormal) : STL
    {
        $this->facets[$position] = $facetNormal;
        return $this;
    }

    /**
     * Deletes a facet normal at a given position.
     *
     * @param int $position
     * @return STL
     */
    public function deleteFacetNormal(int $position) : STL
    {
        $facets = $this->facets;
        unset($facets[$position]);
        $this->facets = array_values($facets);
        return $this;
    }

    /**
     * Converts STL back to array.
     *
     * @return array
     */
    public function toArray() : array
    {
        $facets = array();
        $count = $this->getFacetNormalCount();

        for ($i = 0; $i < $count; $i++) {
            $facets[] = $this->getFacetNormal($i)->toArray();
        }

        return array(
            "name" => $this->getSolidName(),
            "facets" => $facets
        );
    }

    /**
     * Converts STL back to string.
     *
     * @return string
     */
    public function toString() : string
    {
        $string = "solid " . $this->getSolidName() . "\n";

        $count = $this->getFacetNormalCount();

        for ($i = 0; $i < $count; $i++) {
            $string .= $this->getFacetNormal($i)->toString() . "\n";
        }

        $string .= "endsolid";

        return $string;
    }
}