AframeVR\Core\Helpers\MeshAttributes

Complexity

Total Complexity

8

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

25%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
	component()	0	1	?
A	color()	0	7	1
A	transparent()	0	5	1
A	metalness()	0	7	1
A	roughness()	0	7	1
A	src()	0	7	1
A	translate()	0	5	1
A	shader()	0	5	1
A	opacity()	0	5	1

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 21, 2016 - 2:56:57 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         MeshAttributes.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\Core\Helpers;

use \AframeVR\Interfaces\EntityInterface;

/**
 * Many of the primitives are entities that compose a geometric mesh, meaning they
 * primarily prescribe the geometry and material components.
 * Most of the mesh
 * primitives share common attributes, especially for mapping to the material component.
 * These common attributes won’t be described in individual
 * documentation pages for each primitive so they will be listed here
 */
trait MeshAttributes
{

    /**
     * Load component for this entity
     *
     * @param string $component_name            
     * @throws \AframeVR\Core\Exceptions\BadComponentCallException
     * @return object|null
     */
    abstract public function component(string $component_name);

    /**
     * material.color
     *
     * @param string $color            
     * @return EntityInterface
     */
    public function color(string $color = 'gray'): EntityInterface
    {
        $this->component('Material')
            ->shader()
            ->color($color);
        return $this;
    }

    /**
     * material.metalness
     *
     * @param int|float $metalness            
     * @return EntityInterface
     */
    public function metalness(float $metalness = 0): EntityInterface
    {
        $this->component('Material')
            ->shader()
            ->metalness($metalness);
        return $this;
    }

    /**
     * material.roughness
     *
     * @param float $roughness            
     * @return EntityInterface
     */
    public function roughness(float $roughness = 0.5): EntityInterface
    {
        $this->component('Material')
            ->shader()
            ->roughness($roughness);
        return $this;
    }

    /**
     * material.src
     *
     * @param null|string $src            
     * @return EntityInterface
     */
    public function src(string $src = null): EntityInterface
    {
        $this->component('Material')
            ->shader()
            ->src($src);
        return $this;
    }

    /**
     * geometry.translate
     *
     * @param int|float $x            
     * @param int|float $y            
     * @param int|float $z            
     * @return EntityInterface
     */
    public function translate(float $x = 0, float $y = 0, float $z = 0): EntityInterface
    {
        $this->component('Geometry')->translate($x, $y, $z);
        return $this;
    }

    /**
     * material.shader
     *
     * @param string $shader            
     * @return EntityInterface
     */
    public function shader($shader = 'standard'): EntityInterface
    {
        $this->component('Material')->shader($shader);
        return $this;
    }

    /**
     * material.opacity
     *
     * @param float $opacity            
     * @return EntityInterface
     */
    public function opacity(float $opacity = 1.0): EntityInterface
    {
        $this->component('Material')->opacity($opacity);
        return $this;
    }

    /**
     * material.transparent
     *
     * @param bool $transparent            
     * @return EntityInterface
     */
    public function transparent(bool $transparent = false): EntityInterface
    {
        $this->component('Material')->transparent($transparent);
        return $this;
    }
}