Source code for aiogram.types.mask_position
from __future__ import annotations
from typing import TYPE_CHECKING, Any
from .base import TelegramObject
[docs]
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."""
if TYPE_CHECKING:
# DO NOT EDIT MANUALLY!!!
# This section was auto-generated via `butcher`
def __init__(
__pydantic__self__,
*,
point: str,
x_shift: float,
y_shift: float,
scale: float,
**__pydantic_kwargs: Any,
) -> None:
# DO NOT EDIT MANUALLY!!!
# This method was auto-generated via `butcher`
# Is needed only for type checking and IDE support without any additional plugins
super().__init__(
point=point, x_shift=x_shift, y_shift=y_shift, scale=scale, **__pydantic_kwargs
)