aiogram.api.types.mask_position

aiogram/api/types/mask_position.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
from __future__ import annotations

from .base import TelegramObject


class MaskPosition(TelegramObject):
    """
    This object describes the position on faces where a mask should be placed by default.

    Source: https://core.telegram.org/bots/api#maskposition
    """

    point: str
    """The part of the face relative to which the mask should be placed. One of 'forehead',
    'eyes', 'mouth', or 'chin'."""
    x_shift: float
    """Shift by X-axis measured in widths of the mask scaled to the face size, from left to right.
    For example, choosing -1.0 will place mask just to the left of the default mask position."""
    y_shift: float
    """Shift by Y-axis measured in heights of the mask scaled to the face size, from top to
    bottom. For example, 1.0 will place the mask just below the default mask position."""
    scale: float
    """Mask scaling coefficient. For example, 2.0 means double size."""