Sprite.h

Go to the documentation of this file.

// File: Sprite.h
// Description: Implementation of the sprite component, a component for handeling the rendering of
// objects
// Author(s): Ori Balashov (ori.balashov@digipen.edu) Pair Programmed with Aidan Hartman
//            Aidan Hartman (aidan.hartman@digipen.edu) Pair Programmed with Ori Balashov
//            Marcelo Escamilla(marcelo.escamilla@digipen.edu) JSON serialization, and ImGui implementation
// 2025 / 09 / 18
// (C) Digipen 2025
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
#pragma once
 
#include "Framework/Component.h"
#include "Utility/Math/Vector4D.h"
#include "System/Json.h"
 
class Transform;
 
namespace gfx
{
class Mesh;
class Shader;
class Texture;
}

class Sprite : public Component
{
public:
    Sprite();
    Sprite(const std::string& shaderName, const std::string& textureName = "",
           const std::string& meshName                                   = "1x1_mesh");
    Sprite(const Sprite&) = default;
    ~Sprite() override    = default;
 
    auto clone() const -> std::unique_ptr<GameObject> override;
    auto componentShowMenu() -> void override; // for debug ImGUI
    auto onUpdate(float dt) -> void override;
 
    auto endWindow() -> void override
    {
    }; // for debug ImGUI
    auto onRender() -> void override;
    auto load(const Stream& stream) -> void override;
    auto save(Stream& stream) const -> void override;
 
    auto show() -> void;
 
    auto hide() -> void;
 
    [[nodiscard]] auto shown() const -> bool;
 
    auto showWireframe() -> void;
 
    auto hideWireframe() -> void;
 
    [[nodiscard]] auto isWireframe() const -> bool;
 
    auto showFaces() -> void;
 
    auto hideFaces() -> void;
 
    [[nodiscard]] auto isFaces() const -> bool;
 
    auto setFrameIndex(unsigned int index) -> void;
 
    auto color() -> Vector4D&;
 
    [[nodiscard]] auto color() const -> const Vector4D&;
 
    [[nodiscard]] auto getText() const -> std::string;
 
    auto setText(std::string newText) -> void;
    
    auto setOpacity(float opacity) -> void;
 
    auto setMesh(gfx::Mesh* newMesh) -> void;
 
    auto setShader(gfx::Shader* newShader) -> void;
 
    auto setTexture(gfx::Texture* newTexture) -> void;
    
    auto getOpacity() const -> float;
 
    auto getMesh() const -> const gfx::Mesh*;
 
    auto getShader() const -> const gfx::Shader*;
 
    auto getTexture() const -> const gfx::Texture*;
 
    friend auto to_json(json& j, const Sprite& p) -> void;
    friend auto from_json(const json& j, Sprite& p) -> void;
 
private:
    // whether to render the sprite
    bool visible{true};
 
    // render the wireframe
    bool renderLines{false};
 
    // render the faces
    bool renderFaces{true};
 
    // the frame currently being displayed (for sprite sheets)
    unsigned int frameIndex{0};
 
    // The color of the mesh to multiply by
    Vector4D multColor{1.f, 1.f, 1.f, 1.f};
 
    gfx::Mesh* mesh       = nullptr;
    gfx::Shader* shader   = nullptr;
    gfx::Texture* texture = nullptr;
 
    std::string text;
    unsigned maxLineCharLength = 30;

    auto drawDebugLines(AffineMatrix transform) -> void;

    auto drawMeshStandard(const AffineMatrix& transform) -> void;

    auto drawMeshText(Transform& transform) const -> void;
};