ColorGradientPluginFactory.cpp

Go to the documentation of this file.

#include "ColorGradientPluginFactory.hpp"
#include "ColorGradientPlugin.hpp"
#include "ColorGradientDefinitions.hpp"

#include <tuttle/plugin/context/GeneratorPluginFactory.hpp>
#include <tuttle/plugin/ImageGilProcessor.hpp>


namespace tuttle {
namespace plugin {
namespace colorGradient {

/**
 * @brief Function called to describe the plugin main features.
 * @param[in, out]   desc     Effect descriptor
 */
void ColorGradientPluginFactory::describe( OFX::ImageEffectDescriptor& desc )
{
        desc.setLabels( "TuttleColorGradient", "ColorGradient",
                        "Create a color gradient" );
        desc.setPluginGrouping( "tuttle/image/generator" );

        // add the supported contexts
        desc.addSupportedContext( OFX::eContextGeneral );
        desc.addSupportedContext( OFX::eContextFilter );

        // add supported pixel depths
        desc.addSupportedBitDepth( OFX::eBitDepthUByte );
        desc.addSupportedBitDepth( OFX::eBitDepthUShort );
        desc.addSupportedBitDepth( OFX::eBitDepthFloat );

        // plugin flags
        desc.setRenderThreadSafety( OFX::eRenderFullySafe );
        desc.setHostFrameThreading( false );
        desc.setSupportsMultiResolution( false );
        desc.setSupportsMultipleClipDepths( true );
        desc.setSupportsTiles( kSupportTiles );
}

/**
 * @brief Function called to describe the plugin controls and features.
 * @param[in, out]   desc       Effect descriptor
 * @param[in]        context    Application context
 */
void ColorGradientPluginFactory::describeInContext( OFX::ImageEffectDescriptor& desc,
                                                    OFX::EContext               context )
{
        describeGeneratorParamsInContext( desc, context );

        OFX::ChoiceParamDescriptor* gradientType = desc.defineChoiceParam( kGradientType );
        gradientType->appendOption( kGradientType1DLinear );
        gradientType->appendOption( kGradientType1DRadial );
        gradientType->appendOption( kGradientType2D );
        gradientType->setDefault( 0 );

        OFX::IntParamDescriptor* nbPoint = desc.defineIntParam( kNbPoints );
        nbPoint->setDefault( 2 );
        nbPoint->setRange( 2, kMaxNbPoints );
        nbPoint->setDisplayRange( 2, kMaxNbPoints );

        for( unsigned int i = 0; i < kMaxNbPoints; ++i )
        {
                OFX::Double2DParamDescriptor* point = desc.defineDouble2DParam( getPointParamName( i ) );
                point->setLabel( getPointParamName( i ) );
                //              point->setIsSecret( true );
                point->setDoubleType( OFX::eDoubleTypeNormalisedXYAbsolute );
                OFX::RGBAParamDescriptor* color = desc.defineRGBAParam( getColorParamName( i ) );
                color->setLabel( getColorParamName( i ) );
                //              color->setIsSecret( true );
        }
}

/**
 * @brief Function called to create a plugin effect instance
 * @param[in] handle  effect handle
 * @param[in] context    Application context
 * @return  plugin instance
 */
OFX::ImageEffect* ColorGradientPluginFactory::createInstance( OfxImageEffectHandle handle,
                                                              OFX::EContext        context )
{
        return new ColorGradientPlugin( handle );
}

}
}
}