Functions¶
src.helpers.bounds.get_dimensions_from_bounds(bounds: LayerBounds) -> type[LayerDimensions]
¶
Compute width and height based on a set of bounds given.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bounds
|
LayerBounds
|
List of bounds given. |
required |
Returns:
| Type | Description |
|---|---|
type[LayerDimensions]
|
Dict containing height, width, and positioning locations. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_layer_dimensions(layer: Union[ArtLayer, LayerSet]) -> type[LayerDimensions]
¶
Compute the width and height dimensions of a layer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer | LayerSet
|
A layer object |
required |
Returns:
| Type | Description |
|---|---|
type[LayerDimensions]
|
Dict containing height, width, and positioning locations. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_layer_width(layer: Union[ArtLayer, LayerSet]) -> Union[float, int]
¶
src.helpers.bounds.get_layer_height(layer: Union[ArtLayer, LayerSet]) -> Union[float, int]
¶
src.helpers.bounds.get_bounds_no_effects(layer: Union[ArtLayer, LayerSet]) -> LayerBounds
¶
Returns the bounds of a given layer without its effects applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer | LayerSet
|
A layer object |
required |
Returns:
| Name | Type | Description |
|---|---|---|
list |
LayerBounds
|
Pixel location top left, top right, bottom left, bottom right. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_dimensions_no_effects(layer: Union[ArtLayer, LayerSet]) -> type[LayerDimensions]
¶
Compute the dimensions of a layer without its effects applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer | LayerSet
|
A layer object |
required |
Returns:
| Type | Description |
|---|---|
type[LayerDimensions]
|
Dict containing height, width, and positioning locations. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_width_no_effects(layer: Union[ArtLayer, LayerSet]) -> int
¶
Returns the width of a given layer without its effects applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer | LayerSet
|
A layer object |
required |
Returns:
| Name | Type | Description |
|---|---|---|
int |
int
|
Width of the layer in pixels. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_height_no_effects(layer: Union[ArtLayer, LayerSet]) -> int
¶
Returns the height of a given layer without its effects applied.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer | LayerSet
|
A layer object |
required |
Returns:
| Name | Type | Description |
|---|---|---|
int |
int
|
Height of the layer in pixels. |
Source code in src\helpers\bounds.py
src.helpers.bounds.check_textbox_overflow(layer: ArtLayer) -> bool
¶
Check if a TextLayer overflows the bounding box.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer
|
ArtLayer with "kind" of TextLayer. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if text overflowing, else False. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_textbox_bounds(layer: ArtLayer) -> LayerBounds
¶
Get the bounds of a TextLayer's bounding box.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer
|
ArtLayer with "kind" of TextLayer. |
required |
Returns:
| Type | Description |
|---|---|
LayerBounds
|
List of bounds integers. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_textbox_dimensions(layer: ArtLayer) -> type[TextboxDimensions]
¶
Get the dimensions of a TextLayer's bounding box.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer
|
ArtLayer with "kind" of TextLayer. |
required |
Returns:
| Type | Description |
|---|---|
type[TextboxDimensions]
|
Dict containing width and height. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_textbox_width(layer: ArtLayer) -> int
¶
Get the width of a TextLayer's bounding box.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer
|
ArtLayer with 'kind' of TextLayer. |
required |
Returns:
| Type | Description |
|---|---|
int
|
Width of the textbox. |
Source code in src\helpers\bounds.py
src.helpers.bounds.get_textbox_height(layer: ArtLayer) -> int
¶
Get the height of a TextLayer's bounding box.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
ArtLayer
|
ArtLayer with 'kind' of TextLayer. |
required |
Returns:
| Type | Description |
|---|---|
int
|
Height of the textbox. |