AframeVR\Extras\Primitives\Torus

Complexity

Total Complexity

6

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	12	1
A	radius()	0	5	1
A	radiusTubular()	0	5	1
A	segmentsRadial()	0	5	1
A	segmentsTubular()	0	5	1
A	arc()	0	5	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jul 7, 2016 - 7:27:20 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         Torus.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\Primitives;

use \AframeVR\Interfaces\Extras\Primitives\TorusPrimitiveIF;
use \AframeVR\Core\Entity;
use \AframeVR\Core\Helpers\MeshAttributes;

/**
 * <a-torus>
 *
 * The torus primitive creates a donut or circular tube shape. It is an entity that prescribes the geometry with its
 * geometric primitive set to torus.
 */
final class Torus extends Entity implements TorusPrimitiveIF
{

    use MeshAttributes;
    
    /**
     * Init <a-sphere>
     *
     * The sphere primitive creates a spherical or polyhedron shapes.
     * It wraps an entity that prescribes the geometry component with its geometric primitive set to sphere.
     *
     * {@inheritdoc}
     *
     * @return void
     */
    public function init()
    {
        /* Load defaults */
        $this->component('Geometry')->primitive('torus');
        
        
        $this->radius();
        $this->radiusTubular();
        $this->segmentsRadial();
        $this->segmentsTubular();
        $this->arc();
    }
    
    /**
     * Radius of the outer edge of the torus.
     *
     * @param int|float $radius
     * @return TorusPrimitiveIF
     */
    public function radius(float $radius = 1): TorusPrimitiveIF
    {
        $this->component('Geometry')->radius($radius);
        return $this;
    }
    
    /**
     * Radius of the tube.
     *
     * @param double $radiusTubular
     * @return TorusPrimitiveIF
     */
    public function radiusTubular(float $radiusTubular = 0.2): TorusPrimitiveIF
    {
        $this->component('Geometry')->radiusTubular($radiusTubular);
        return $this;
    }
    
    /**
     * Number of segments along the circumference of the tube ends.
     * A higher number means the tube will be more round.
     *
     * @param int $segmentsRadial
     * @return TorusPrimitiveIF
     */
    public function segmentsRadial(int $segmentsRadial = 36): TorusPrimitiveIF
    {
        $this->component('Geometry')->segmentsRadial($segmentsRadial);
        return $this;
    }
    
    /**
     * Number of segments along the circumference of the tube face.
     * A higher number means the tube will be more round.
     *
     * @param int $segmentsTubular
     * @return TorusPrimitiveIF
     */
    public function segmentsTubular(int $segmentsTubular = 8): TorusPrimitiveIF
    {
        $this->component('Geometry')->segmentsTubular($segmentsTubular);
        return $this;
    }
    
    /**
     * Central angle.
     *
     * @param int|float $arc
     * @return TorusPrimitiveIF
     */
    public function arc(float $arc = 360): TorusPrimitiveIF
    {
        $this->component('Geometry')->arc($arc);
        return $this;
    }
}