class MaskPosition

This object describes the position on faces where a mask should be placed by default.

Methods

__construct(string $point, float $x_shift, float $y_shift, float $scale)

No description

string
getPoint()

The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

float
getXShift()

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.

float
getYShift()

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.

float
getScale()

Mask scaling coefficient. For example, 2.0 means double size.

Details

at line 16
__construct(string $point, float $x_shift, float $y_shift, float $scale)

No description

Parameters

string $point
float $x_shift
float $y_shift
float $scale

at line 27
string getPoint()

The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

Return Value

string

at line 35
float getXShift()

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.

Return Value

float

at line 43
float getYShift()

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.

Return Value

float

at line 51
float getScale()

Mask scaling coefficient. For example, 2.0 means double size.

Return Value

float