UIImage.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include "open3d/visualization/gui/Widget.h"
#include "open3d/visualization/rendering/RendererHandle.h"
 
namespace open3d {
 
namespace t {
namespace geometry {
class Image;
}
}
 
namespace geometry {
class Image;
}  // namespace geometry
 
namespace visualization {
 
namespace rendering {
class Renderer;
}
 
namespace gui {
 
class UIImage {
public:
    explicit UIImage(const char* image_path);
    explicit UIImage(std::shared_ptr<geometry::Image> image);
    explicit UIImage(std::shared_ptr<t::geometry::Image> image);
    explicit UIImage(visualization::rendering::TextureHandle texture_id,
                     float u0 = 0.0f,
                     float v0 = 0.0f,
                     float u1 = 1.0f,
                     float v1 = 1.0f);
    ~UIImage();

    void UpdateImage(std::shared_ptr<geometry::Image> image);

    void UpdateImage(std::shared_ptr<t::geometry::Image> image);
 
    enum class Scaling {
        NONE,   
        ANY,    
        ASPECT  
    };
    void SetScaling(Scaling scaling);
    Scaling GetScaling() const;
 
    Size CalcPreferredSize(const LayoutContext& context,
                           const Widget::Constraints& constraints) const;
 
    struct DrawParams {
        // Default values are to make GCC happy and contented,
        // pos and size don't have reasonable defaults.
        float pos_x = 0.0f;
        float pos_y = 0.0f;
        float width = 0.0f;
        float height = 0.0f;
        float u0 = 0.0f;
        float v0 = 0.0f;
        float u1 = 1.0f;
        float v1 = 1.0f;
        visualization::rendering::TextureHandle texture;
        bool image_size_changed = false;
    };
    DrawParams CalcDrawParams(visualization::rendering::Renderer& renderer,
                              const Rect& frame) const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace gui
}  // namespace visualization
}  // namespace open3d