Source code for ansys.aedt.toolkits.common.ui.utils.images.load_images

# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import os
import pathlib

from ansys.aedt.toolkits.common.ui.logger_handler import logger
from ansys.aedt.toolkits.common.ui.models import general_settings




class LoadImages(object):
    """
    A utility class for managing image and icon paths in a PySide6 desktop application.

    This class facilitates the retrieval of image and icon paths, allowing the application to access
    and display graphical assets.

    Parameters
    ----------
    path : str, optional
        The base path to the directory containing images. If not provided, the default path is the directory
        where the script is located.

    Examples
    --------
    >>> image_loader = LoadImages()
    >>> icon_path = image_loader.icon_path("my_icon.png")
    >>> image_path = image_loader.image_path("my_image.png")

    """

    def __init__(self, path=None):
        self.images_path = self.__init_images_path(path)



    def icon_path(self, icon_name):
        """
        Get the full path for the specified icon.

        Parameters
        ----------
        icon_name : str
            The name of the icon file.

        Returns
        -------
        str
            The full path to the specified icon.
        """
        return self.__build_asset_path("icons", icon_name)




    def image_path(self, file_name):
        """
        Get the full path for the specified image file.

        Parameters
        ----------
        file_name : str
            The name of the image file.

        Returns
        -------
        str
            The full path to the specified image file.
        """
        return self.__build_asset_path("files", file_name)


    @staticmethod
    def __init_images_path(path):
        if (not path or not hasattr(general_settings, "images")) and not general_settings.images:
            return pathlib.Path(__file__).resolve().parent
        else:
            if path:
                abs_path = os.path.abspath(path)
            else:
                abs_path = general_settings.images
            if not os.path.exists(abs_path):
                msg = f"{abs_path} does not exist"
                logger.error(msg)
                raise FileNotFoundError(msg)
            return abs_path

    def __build_asset_path(self, folder, filename):
        path = os.path.join(self.images_path, folder, filename)
        if not os.path.exists(path):
            logger.error("{} does not exist".format(folder.capitalize()))
            return False
        return path