AframeVR\Extras\Primitives\Camera

Complexity

Total Complexity

9

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	reset()	0	6	1
A	active()	0	8	1
A	far()	0	8	1
A	fov()	0	8	1
A	lookControls()	0	8	1
A	near()	0	8	1
A	wasdControls()	0	8	1
A	zoom()	0	8	1
A	cursor()	0	8	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jul 4, 2016 - 1:31:08 AM
 * 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         Camera.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\Core\Entity;
use \AframeVR\Interfaces\EntityInterface;

class Camera extends Entity implements EntityInterface
{

    /**
     * Init <a-camera>
     *
     * The camera primitive places the user somewhere within the scene. It is an entity that prescribes the camera
     * component with mappings to controls-related components.
     *
     * @return void
     */
    public function reset()
    {
        parent::reset();
        $this->child()->entity()->component('Camera');
        $this->active(false);
    }

    /**
     * camera.active
     *
     * @param bool $active            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function active(bool $active)
    {
        $this->child()
            ->entity()
            ->component('Camera')
            ->active($active);
        return $this;
    }

    /**
     * camera.far
     *
     * @param float $far            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function far(float $far)
    {
        $this->child()
            ->entity()
            ->component('Camera')
            ->far($far);
        return $this;
    }

    /**
     * camera.fov
     *
     * @param float $fov            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function fov(float $fov)
    {
        $this->child()
            ->entity()
            ->component('Camera')
            ->fov($fov);
        return $this;
    }

    /**
     * look-controls.enabled
     *
     * @param bool $look_controls            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function lookControls(bool $look_controls)
    {
        $this->child()
            ->entity()
            ->component('LookControls')
            ->enabled($look_controls);
        return $this;
    }

    /**
     * camera.near
     *
     * @param float $near            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function near(float $near)
    {
        $this->child()
            ->entity()
            ->component('Camera')
            ->near($near);
        return $this;
    }

    /**
     * wasd-controls.enabled
     *
     * @param bool $wasd_controls            
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function wasdControls(bool $wasd_controls = true)
    {
        $this->child()
            ->entity()
            ->component('WASDControls')
            ->enabled($wasd_controls);
        return $this;
    }

    /**
     * camera.zoom
     *
     * @param int|float $zoom            

Consider making the type for parameter $zoom a bit more specific; maybe use double.

     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function zoom(float $zoom)
    {
        $this->child()
            ->entity()
            ->component('Camera')
            ->zoom($zoom);
        return $this;
    }

    /**
     * Activate cursor
     *
     * @return \AframeVR\Extras\Primitives\Camera
     */
    public function cursor()
    {
        $this->child()
            ->entity()
            ->child()
            ->cursor();
        return $this;
    }
}