linux-wallpaperengine-kde/src/WallpaperEngine/Core/Objects/CImage.h

#pragma once

#include "WallpaperEngine/Core/Objects/Images/CMaterial.h"

#include "WallpaperEngine/Core/Core.h"
#include "WallpaperEngine/Core/CObject.h"

#include "WallpaperEngine/Assets/CContainer.h"

#include "WallpaperEngine/Core/UserSettings/CUserSettingBoolean.h"
#include "WallpaperEngine/Core/UserSettings/CUserSettingFloat.h"
#include "WallpaperEngine/Core/UserSettings/CUserSettingVector3.h"

namespace WallpaperEngine::Core
{
    class CScene;
}

namespace WallpaperEngine::Core::Objects
{
    using json = nlohmann::json;
    using namespace WallpaperEngine::Assets;
    using namespace WallpaperEngine::Core::UserSettings;

    /**
     * Represents an image in a background
     */
    class CImage : public CObject
    {
        friend class CObject;
    public:
        static CObject* fromJSON (
            CScene* scene, json data, CContainer* container, CUserSettingBoolean* visible, uint32_t id,
            std::string name, CUserSettingVector3* origin, CUserSettingVector3* scale, const glm::vec3& angles
        );

        /**
         * @return The base material to use for the image
         */
        [[nodiscard]] const Images::CMaterial* getMaterial () const;
        /**
         * @return The size of the image
         */
        [[nodiscard]] const glm::vec2& getSize () const;
        /**
         * @return The type of alignment to use for image positioning
         */
        [[nodiscard]] const std::string& getAlignment () const;
        /**
         * @return The alpha value for the image's rendering
         */
        [[nodiscard]] float getAlpha () const;
        /**
         * @return The color to use for the image
         */
        [[nodiscard]] glm::vec3 getColor () const;
        /**
         * @return The brightness to use for the image
         */
        [[nodiscard]] float getBrightness () const;
        /**
         * @return The color blending mode to be used, special value for shaders
         */
        [[nodiscard]] uint32_t getColorBlendMode () const;
        /**
         * @return Parallax depth of the image
         */
        [[nodiscard]] const glm::vec2& getParallaxDepth () const;
        /**
         * @return If the image is fullscreen or not
         */
        [[nodiscard]] bool isFullscreen () const;
        /**
         * @return If the image is passthrough or not
         */
        [[nodiscard]] bool isPassthrough () const;
        /**
         * @return If the image is autosized or not
         */
        [[nodiscard]] bool isAutosize () const;

    protected:
        CImage (
            CScene* scene, Images::CMaterial* material, CUserSettingBoolean* visible, uint32_t id, std::string name,
            CUserSettingVector3* origin, CUserSettingVector3* scale, const glm::vec3& angles, const glm::vec2& size,
            std::string alignment, CUserSettingVector3* color, CUserSettingFloat* alpha, float brightness,
            uint32_t colorBlendMode, const glm::vec2& parallaxDepth, bool fullscreen, bool passthrough, bool autosize
        );

        /**
         * Type value used to differentiate the different types of objects in a background
         */
        static const std::string Type;

    private:
        /** The image's size */
        glm::vec2 m_size;
        /** Parallax depth */
        const glm::vec2 m_parallaxDepth;
        /** Base material for the image */
        Images::CMaterial* m_material;
        /** What type of alignment to use for the image's position */
        std::string m_alignment;
        /** The alpha value for the image */
        CUserSettingFloat* m_alpha;
        /** The brightness for the image */
        float m_brightness;
        /** The color to use for the image */
        CUserSettingVector3* m_color;
        /** The color blending mode used for the image, special value for shaders */
        uint32_t m_colorBlendMode;
        /** If the image is fullscreen or not */
        bool m_fullscreen;
        /** If the image is passthrough or not */
        bool m_passthrough;
        /** If the image's size should be automatically determined */
        bool m_autosize;
    };
}