MaskPosition::getYShift()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
eloc 1
c 0
b 0
f 0
dl 0
loc 3
ccs 0
cts 2
cp 0
rs 10
cc 1
nc 1
nop 0
crap 2
1
<?php
2
3
namespace TelegramBot\Api\Types;
4
5
use TelegramBot\Api\BaseType;
6
use TelegramBot\Api\TypeInterface;
7
8
/**
9
 * Class MaskPosition
10
 * This object describes the position on faces where a mask should be placed by default.
11
 *
12
 * @package TelegramBot\Api\Types
13
 * @author bernard-ng <[email protected]>
14
 */
15
class MaskPosition extends BaseType implements TypeInterface
16
{
17
    protected static $requiredParams = ['point', 'x_shift', 'y_shift', 'scale'];
18
19
    protected static $map = [
20
        'point' => true,
21
        'x_shift' => true,
22
        'y_shift' => true,
23
        'scale' => true,
24
    ];
25
26
    /**
27
     * The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
28
     *
29
     * @var string
30
     */
31
    protected $point;
32
33
    /**
34
     * Shift by X-axis measured in widths of the mask scaled to the face size, from left to right.
35
     * For example, choosing -1.0 will place mask just to the left of the default mask position.
36
     *
37
     * @var float
38
     */
39
    protected $xShift;
40
41
    /**
42
     * Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom.
43
     * For example, 1.0 will place the mask just below the default mask position.
44
     *
45
     * @var float
46
     */
47
    protected $yShift;
48
49
    /**
50
     * Mask scaling coefficient. For example, 2.0 means double size.
51
     *
52
     * @var float
53
     */
54
    protected $scale;
55
56
    /**
57
     * @return string
58
     */
59
    public function getPoint()
60
    {
61
        return $this->point;
62
    }
63
64
    /**
65
     * @param string $point
66
     * @return void
67
     */
68
    public function setPoint($point)
69
    {
70
        $this->point = $point;
71
    }
72
73
    /**
74
     * @return float
75
     */
76
    public function getXShift()
77
    {
78
        return $this->xShift;
79
    }
80
81
    /**
82
     * @param float $xShift
83
     * @return void
84
     */
85
    public function setXShift($xShift)
86
    {
87
        $this->xShift = $xShift;
88
    }
89
90
    /**
91
     * @return float
92
     */
93
    public function getYShift()
94
    {
95
        return $this->yShift;
96
    }
97
98
    /**
99
     * @param float $yShift
100
     * @return void
101
     */
102
    public function setYShift($yShift)
103
    {
104
        $this->yShift = $yShift;
105
    }
106
107
    /**
108
     * @return float
109
     */
110
    public function getScale()
111
    {
112
        return $this->scale;
113
    }
114
115
    /**
116
     * @param float $scale
117
     * @return void
118
     */
119
    public function setScale($scale)
120
    {
121
        $this->scale = $scale;
122
    }
123
}
124