MaterialModifier.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <Eigen/Core>
 
#include "visualization/rendering/RendererHandle.h"
 
namespace cloudViewer {
namespace visualization {
namespace rendering {
 
struct TextureSamplerParameters {
    enum class MinFilter : uint8_t {
        Nearest = 0,  
        Linear =
                1,  
        NearestMipmapNearest =
                2,  
        LinearMipmapNearest = 3,  
        NearestMipmapLinear = 4,  
        LinearMipmapLinear = 5    
    };
 
    enum class MagFilter : uint8_t {
        Nearest = 0,  
        Linear =
                1,  
    };
 
    enum class WrapMode : uint8_t {
        ClampToEdge,     
        Repeat,          
        MirroredRepeat,  
    };
 
    /* filterMag = MagFilter::Nearest
     * filterMin = MinFilter::Nearest
     * wrapU = WrapMode::ClampToEdge
     * wrapV = WrapMode::ClampToEdge
     * wrapW = WrapMode::ClampToEdge
     * anisotropy = 0
     */
    static TextureSamplerParameters Simple();
 
    /* filterMag = MagFilter::Linear
     * filterMin = MinFilter::LinearMipmapLinear
     * wrapU = WrapMode::Repeat
     * wrapV = WrapMode::Repeat
     * wrapW = WrapMode::Repeat
     * anisotropy = 8
     */
    static TextureSamplerParameters Pretty();
 
    /* filterMag = MagFilter::Linear
     * filterMin = MinFilter::Linear
     * wrapU = WrapMode::ClampToEdge
     * wrapV = WrapMode::ClampToEdge
     * wrapW = WrapMode::ClampToEdge
     * anisotropy = 0
     */
    static TextureSamplerParameters LinearClamp();
 
    TextureSamplerParameters() = default;
 
    // Creates a TextureSampler with the default parameters but setting the
    // filtering and wrap modes. 'minMag' is filtering for both minification and
    // magnification 'uvw' is wrapping mode for all texture coordinate axes
    explicit TextureSamplerParameters(MagFilter min_mag,
                                      WrapMode uvw = WrapMode::ClampToEdge);
 
    // Creates a TextureSampler with the default parameters but setting the
    // filtering and wrap modes. 'uvw' is wrapping mode for all texture
    // coordinate axes
    TextureSamplerParameters(MinFilter min,
                             MagFilter mag,
                             WrapMode uvw = WrapMode::ClampToEdge);
 
    TextureSamplerParameters(
            MinFilter min, MagFilter mag, WrapMode u, WrapMode v, WrapMode w);
 
    // \param a needs to be a power of 2
    void SetAnisotropy(std::uint8_t a);
 
    std::uint8_t GetAnisotropy() const { return anisotropy; }
 
    MagFilter filter_mag = MagFilter::Nearest;
    MinFilter filter_min = MinFilter::Nearest;
    WrapMode wrap_u = WrapMode::ClampToEdge;
    WrapMode wrap_v = WrapMode::ClampToEdge;
    WrapMode wrap_w = WrapMode::ClampToEdge;
 
private:
    std::uint8_t anisotropy = 0;
};
 
class MaterialModifier {
public:
    virtual ~MaterialModifier() = default;
 
    virtual MaterialModifier& SetParameter(const char* parameter,
                                           int value) = 0;
    virtual MaterialModifier& SetParameter(const char* parameter,
                                           float value) = 0;
    virtual MaterialModifier& SetParameter(const char* parameter,
                                           const Eigen::Vector3f& value) = 0;
    virtual MaterialModifier& SetColor(const char* parameter,
                                       const Eigen::Vector3f& value,
                                       bool srgb) = 0;
    virtual MaterialModifier& SetColor(const char* parameter,
                                       const Eigen::Vector4f& value,
                                       bool srgb) = 0;
    virtual MaterialModifier& SetTexture(
            const char* parameter,
            const TextureHandle& texture,
            const TextureSamplerParameters& sampler) = 0;
 
    virtual MaterialModifier& SetDoubleSided(bool doubleSided) = 0;
 
    virtual MaterialInstanceHandle Finish() = 0;
};
 
}  // namespace rendering
}  // namespace visualization
}  // namespace cloudViewer