1
|
|
|
<?php |
2
|
|
|
/** @formatter:off |
3
|
|
|
* ****************************************************************** |
4
|
|
|
* Created by Marko Kungla on Jul 4, 2016 - 1:16:14 AM |
5
|
|
|
* Contact [email protected] |
6
|
|
|
* @copyright 2016 Marko Kungla - https://github.com/mkungla |
7
|
|
|
* @license The MIT License (MIT) |
8
|
|
|
* |
9
|
|
|
* @category AframeVR |
10
|
|
|
* @package aframe-php |
11
|
|
|
* |
12
|
|
|
* Lang PHP (php version >= 7) |
13
|
|
|
* Encoding UTF-8 |
14
|
|
|
* File CameraComponent.php |
15
|
|
|
* Code format PSR-2 and 12 |
16
|
|
|
* @link https://github.com/mkungla/aframe-php |
17
|
|
|
^ @issues https://github.com/mkungla/aframe-php/issues |
18
|
|
|
* ******************************************************************** |
19
|
|
|
* Contributors: |
20
|
|
|
* @author Marko Kungla <[email protected]> |
21
|
|
|
* ******************************************************************** |
22
|
|
|
* Comments: |
23
|
|
|
* @formatter:on */ |
24
|
|
|
namespace AframeVR\Core\Components\Camera; |
25
|
|
|
|
26
|
|
|
use \AframeVR\Interfaces\Core\Components\Camera\CameraInterface; |
27
|
|
|
use \AframeVR\Core\Helpers\ComponentAbstract; |
28
|
|
|
|
29
|
|
|
class CameraComponent extends ComponentAbstract implements CameraInterface |
30
|
|
|
{ |
31
|
|
|
/** |
32
|
|
|
* Initialize Component |
33
|
|
|
* |
34
|
|
|
* {@inheritdoc} |
35
|
|
|
* |
36
|
|
|
* @return bool |
37
|
|
|
*/ |
38
|
6 |
|
public function initializeComponent(): bool |
39
|
|
|
{ |
40
|
6 |
|
$this->setDomAttribute('camera'); |
41
|
6 |
|
return true; |
42
|
|
|
} |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* Camera active |
46
|
|
|
* |
47
|
|
|
* Whether the camera is currently the active camera in a scene with multiple cameras. |
48
|
|
|
* |
49
|
|
|
* @param bool $active |
50
|
|
|
* @return void |
51
|
|
|
*/ |
52
|
1 |
|
public function active(bool $active = false) |
53
|
|
|
{ |
54
|
1 |
|
$this->dom_attributes['active'] = $active; |
55
|
1 |
|
} |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* Camera frustum far clipping plane. |
59
|
|
|
* |
60
|
|
|
* @param int|float $far |
61
|
|
|
* @return void |
62
|
|
|
*/ |
63
|
1 |
|
public function far(float $far = 10000) |
64
|
|
|
{ |
65
|
1 |
|
$this->dom_attributes['far'] = $far; |
66
|
1 |
|
} |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* Field of view (in degrees). |
70
|
|
|
* |
71
|
|
|
* @param int $fov |
72
|
|
|
* @return void |
73
|
|
|
*/ |
74
|
1 |
|
public function fov(int $fov = 80) |
75
|
|
|
{ |
76
|
1 |
|
$this->dom_attributes['fov'] = $fov; |
77
|
1 |
|
} |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Camera frustum near clipping plane. |
81
|
|
|
* |
82
|
|
|
* @param float $near |
83
|
|
|
* @return void |
84
|
|
|
*/ |
85
|
4 |
|
public function near(float $near = 0.5) |
86
|
|
|
{ |
87
|
4 |
|
$this->dom_attributes['near'] = $near; |
88
|
4 |
|
} |
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* Camera zoom |
92
|
|
|
* |
93
|
|
|
* @param float $zoom |
|
|
|
|
94
|
|
|
* @return void |
95
|
|
|
*/ |
96
|
|
|
public function zoom(float $zoom = 1) |
97
|
|
|
{ |
98
|
|
|
$this->dom_attributes['zoom'] = $zoom; |
99
|
|
|
} |
100
|
|
|
} |
This check looks for
@param
annotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.