COP_SlapcompInputFetcher.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 */

#pragma once

#include "COP_API.h"

#include <IMX/IMX_Layer.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_NonCopyable.h>

class COP_CableStructure;

/// Interface for getting IMX_Layer inputs for a slapcomp program on demand.
class COP_API COP_SlapcompInputFetcher : public UT_NonCopyable
{
public:
    virtual ~COP_SlapcompInputFetcher() {}

    /// Gets the desired IMX_Layer. If the given layer name is C and no such
    /// layer exists, this method will also check for a color layer.
    IMX_LayerConstPtr getLayer(const UT_StringHolder& layer_name)
    {
        using namespace UT::Literal;
        IMX_LayerConstPtr layer = getLayerInternal(layer_name);
        if (!layer && layer_name == "C"_sh)
            layer = getLayerInternal("color"_sh);
        return layer;
    }

    /// Returns types and names of all inputs available to this fetcher.
    virtual COP_CableStructure getLayerStructure() const = 0;

protected:
    /// Implementation for getLayer.
    /// Does not need to worry about aliasing the layer name C to color.
    virtual IMX_LayerConstPtr getLayerInternal(
            const UT_StringHolder& layer_name) = 0;
};