AframeVR\Extras\Primitives

Complexity

Total Complexity

11

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	box()	0	4	1
A	sphere()	0	4	1
A	cylinder()	0	4	1
A	plane()	0	4	1
A	sky()	0	4	1
A	DOMAppendPrimitives()	0	17	1
A	DOMappendPrimitiveCollection()	0	9	3
A	DOMappendPrimitiveSky()	0	7	2

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 20, 2016 - 10:21:07 PM
 * Contact      marko@okramlabs.com
 * @copyright   2016 Marko Kungla - https://github.com/mkungla
 * @license     The MIT License (MIT)
 * 
 * @category       AframeVR
 * @package        aframe-php
 * 
 * Lang         PHP (php version >= 7)
 * Encoding     UTF-8
 * File         Primitives.php
 * Code format  PSR-2 and 12
 * @link        https://github.com/mkungla/aframe-php
 ^ @issues      https://github.com/mkungla/aframe-php/issues
 * ********************************************************************
 * Contributors:
 * @author Marko Kungla <marko@okramlabs.com>
 * ********************************************************************
 * Comments:
 * @formatter:on */
namespace AframeVR\Extras;

use \AframeVR\Extras\Primitives\{
    Sphere,
    Box,
    Cylinder,
    Plane,
    Sky
};
use \AframeVR\Core\Entity;

trait Primitives
{

    /**
     *
     * @var array $spheres
     */
    protected $spheres = array();

    /**
     *
     * @var array $boxes
     */
    protected $boxes = array();

    /**
     *
     * @var array $cylinders
     */
    protected $cylinders = array();

    /**
     *
     * @var array $planes
     */
    protected $planes = array();

    /**
     *
     * @var \AframeVR\Extras\Primitives\Sky $sky
     */
    protected $sky;

    /**
     * A-Frame Primitive box
     *
     * @param string $name            
     * @return Entity
     */
    public function box(string $name = 'untitled'): Entity
    {
        return $this->boxes[$name] ?? $this->boxes[$name] = new Box();
    }

    /**
     * A-Frame Primitive sphere
     *
     * @param string $name            
     * @return Entity
     */
    public function sphere(string $name = 'untitled'): Entity
    {
        return $this->spheres[$name] ?? $this->spheres[$name] = new Sphere();
    }

    /**
     * A-Frame Primitive cylinder
     *
     * @param string $name            
     * @return Entity
     */
    public function cylinder(string $name = 'untitled'): Entity
    {
        return $this->cylinders[$name] ?? $this->cylinders[$name] = new Cylinder();
    }

    /**
     * A-Frame Primitive plane
     *
     * @param string $name            
     * @return Entity
     */
    public function plane(string $name = 'untitled'): Entity
    {
        return $this->planes[$name] ?? $this->planes[$name] = new Plane();
    }

    /**
     * A-Frame Primitive sky
     *
     * @return Entity
     */
    public function sky(): Entity
    {
        return $this->sky = new Sky();
    }

    /**
     * Add all used primitevs to the scene
     *
     * @param \DOMDocument $aframe_dom            
     * @param \DOMElement $scene            
     * @return void
     */
    protected function DOMAppendPrimitives(\DOMDocument &$aframe_dom, \DOMElement &$scene)
    {
        /* Add sphiers to DOM */
        $this->DOMappendPrimitiveCollection($this->spheres, $aframe_dom, $scene);
        
        /* Add boxes to DOM */
        $this->DOMappendPrimitiveCollection($this->boxes, $aframe_dom, $scene);
        
        /* Add cylinders to DOM */
        $this->DOMappendPrimitiveCollection($this->cylinders, $aframe_dom, $scene);
        
        /* Add planes to DOM */
        $this->DOMappendPrimitiveCollection($this->planes, $aframe_dom, $scene);
        
        /* Add sky to DOM */
        $this->DOMappendPrimitiveSky($aframe_dom, $scene);
    }

    /**
     * Append Primitive Collection
     *
     * @param array $primitives            
     * @param \DOMDocument $aframe_dom            
     * @param \DOMElement $scene            
     * @return void
     */
    private function DOMappendPrimitiveCollection(array $primitives, \DOMDocument &$aframe_dom, \DOMElement &$scene)
    {
        if (! empty($primitives)) {
            foreach ($primitives as $primitive) {
                $entity = $primitive->DOMElement($aframe_dom);
                $scene->appendChild($entity);
            }
        }
    }

    /**
     * Append SKY primitive
     *
     * @param \DOMDocument $aframe_dom            
     * @param \DOMElement $scene            
     * @return void
     */
    private function DOMappendPrimitiveSky(\DOMDocument &$aframe_dom, \DOMElement &$scene)
    {
        if (is_object($this->sky)) {
            $sky = $this->sky->DOMElement($aframe_dom);
            $scene->appendChild($sky);
        }
    }
}