/** @brief The describe in context function, passed a plugin descriptor and a context */
void PropTesterPluginFactory::describeInContext(OFX::ImageEffectDescriptor &desc, ContextEnum context)
{
// Source clip only in the filter context
if(context == eContextGeneral) {
// create the mandated source clip
ClipDescriptor *srcClip = desc.defineClip("Extra");
srcClip->addSupportedComponent(ePixelComponentRGBA);
srcClip->setTemporalClipAccess(false);
srcClip->setOptional(false);
srcClip->setSupportsTiles(true);
srcClip->setIsMask(false);
}
// Source clip only in the filter context
if(context == eContextFilter || context == eContextGeneral) {
// create the mandated source clip
ClipDescriptor *srcClip = desc.defineClip(kOfxImageEffectSimpleSourceClipName);
srcClip->addSupportedComponent(ePixelComponentRGBA);
srcClip->setTemporalClipAccess(false);
//srcClip->setOptional(false);
srcClip->setSupportsTiles(true);
srcClip->setIsMask(false);
}
// create the mandated output clip
ClipDescriptor *dstClip = desc.defineClip(kOfxImageEffectOutputClipName);
dstClip->addSupportedComponent(ePixelComponentRGBA);
dstClip->setTemporalClipAccess(false);
//dstClip->setOptional(false);
dstClip->setSupportsTiles(true);
dstClip->setIsMask(false);
// make some pages and to things in
PageParamDescriptor *page1 = desc.definePageParam("page1");
PageParamDescriptor *page2 = desc.definePageParam("page2");
PageParamDescriptor *page3 = desc.definePageParam("page3");
// make an int param
IntParamDescriptor *iParam = desc.defineIntParam("Int");
iParam->setLabels("Int", "Int", "Int");
iParam->setScriptName("int");
iParam->setHint("An integer parameter");
iParam->setDefault(0);
iParam->setRange(-100, 100);
iParam->setDisplayRange(-100, 100);
page1->addChild(*iParam);
// make a 2D int param
Int2DParamDescriptor *i2DParam = desc.defineInt2DParam("Int2D");
i2DParam->setLabels("Int2D", "Int2D", "Int2D");
i2DParam->setScriptName("int2D");
i2DParam->setHint("A 2D integer parameter");
i2DParam->setDefault(0, 0);
i2DParam->setRange(-100, -100, 100, 100);
i2DParam->setDisplayRange(-100, -100, 100, 100);
page1->addChild(*i2DParam);
// make a 3D int param
Int3DParamDescriptor *i3DParam = desc.defineInt3DParam("Int3D");
i3DParam->setLabels("Int3D", "Int3D", "Int2D");
i3DParam->setScriptName("int3D");
i3DParam->setHint("A 3D integer parameter");
i3DParam->setDefault(0, 0, 0);
i3DParam->setRange(-100, -100, -100, 100, 100, 100);
i3DParam->setDisplayRange(-100, -100, -100, 100, 100, 100);
page1->addChild(*i3DParam);
page1->addChild(PageParamDescriptor::gSkipColumn);
// boolean
BooleanParamDescriptor *boolean = desc.defineBooleanParam("bool");
boolean->setLabels("bool", "bool", "bool");
boolean->setDefault(false);
page1->addChild(*boolean);
// choice
ChoiceParamDescriptor *choice = desc.defineChoiceParam("choice");
choice->setLabels("choice", "choice", "choice");
choice->appendOption("This", "This");
choice->appendOption("That", "That");
choice->appendOption("The Other", "The Other");
choice->resetOptions();
choice->appendOption("Tom", "Tom");
choice->appendOption("Dick", "Dick");
choice->appendOption("Harry", "Harry");
choice->setDefault(0);
page1->addChild(*choice);
page1->addChild(PageParamDescriptor::gSkipColumn);
// push button
PushButtonParamDescriptor *push = desc.definePushButtonParam("push");
push->setLabels("push me", "push me", "push me Big Nose");
page1->addChild(*push);
// make a custom param
CustomParamDescriptor *custom = desc.defineCustomParam("custom");
custom->setLabels("custom", "custom", "custom");
custom->setDefault("wibble");
// rgba colours
RGBAParamDescriptor *rgba = desc.defineRGBAParam("rgba");
rgba->setLabels("rgba", "rgba", "rgba");
rgba->setDefault(0, 0, 0, 1);
page1->addChild(*rgba);
RGBParamDescriptor *rgba2 = desc.defineRGBParam("rgbaCustom");
rgba2->setLabels("RGB Custom", "RGB Custom", "RGB Custom");
rgba2->setDefault(0, 1, 1);
rgba2->setInteractDescriptor(new ColourInteractDescriptor<0>);
page1->addChild(*rgba2);
RGBParamDescriptor *rgba3 = desc.defineRGBParam("rgbaCustom2");
rgba3->setLabels("RGB Custom 2", "RGB Custom 2", "RGB Custom 2");
rgba3->setDefault(1, 0, 1);
rgba3->setInteractDescriptor(new ColourInteractDescriptor<1>);
page1->addChild(*rgba3);
page1->addChild(PageParamDescriptor::gSkipRow);
// rgb colour
RGBParamDescriptor *rgb = desc.defineRGBParam("rgb");
rgb->setLabels("rgb", "rgb", "rgb");
rgb->setDefault(0, 0, 0);
page1->addChild(*rgb);
// make a 1D double parameter of each type
describeDoubleParam(desc, "double", eDoubleTypePlain, -100, 100, page2);
describeDoubleParam(desc, "angle", eDoubleTypeAngle, -100, 100, page2);
describeDoubleParam(desc, "scale", eDoubleTypeScale, -1, 1, page2);
describeDoubleParam(desc, "time", eDoubleTypeTime, -100, 100, page2);
describeDoubleParam(desc, "absoluteTime", eDoubleTypeAbsoluteTime, 0, 1000, page2);
describeDoubleParam(desc, "X_Value", eDoubleTypeNormalisedX, -1, 1, page2);
describeDoubleParam(desc, "Y_Value", eDoubleTypeNormalisedY, -1, 1, page2);
describeDoubleParam(desc, "X_Position", eDoubleTypeNormalisedXAbsolute, -1, 1, page2);
describeDoubleParam(desc, "Y_Position", eDoubleTypeNormalisedYAbsolute, -1, 1, page2);
page2->addChild(PageParamDescriptor::gSkipColumn);
// make a 2D double parameter of each type
describe2DDoubleParam(desc, "double2D", eDoubleTypePlain, -100, 100, page2);
describe2DDoubleParam(desc, "angle2D", eDoubleTypeAngle, -100, 100, page2);
describe2DDoubleParam(desc, "scale2D", eDoubleTypeScale, -1, 1, page2);
describe2DDoubleParam(desc, "XY_Value", eDoubleTypeNormalisedXY, -1, 1, page2);
describe2DDoubleParam(desc, "XY_Position", eDoubleTypeNormalisedXYAbsolute, -1, 1, page2);
page2->addChild(PageParamDescriptor::gSkipColumn);
// make a 3D double parameter of each type
describe3DDoubleParam(desc, "double3D", eDoubleTypePlain, -100, 100, page2);
describe3DDoubleParam(desc, "angle3D", eDoubleTypeAngle, -100, 100, page2);
describe3DDoubleParam(desc, "scale3D", eDoubleTypeScale, -1, 1, page2);
// make a string param param of each type
describeStringParam(desc, "singleLine", eStringTypeSingleLine, page3);
describeStringParam(desc, "multiLine", eStringTypeMultiLine, page3);
describeStringParam(desc, "filePath", eStringTypeFilePath, page3);
describeStringParam(desc, "dirPath", eStringTypeDirectoryPath, page3);
describeStringParam(desc, "label", eStringTypeLabel, page3);
}
/**
* @brief Function called to describe the plugin controls and features.
* @param[in, out] desc Effect descriptor
* @param[in] context Application context
*/
void PinningPluginFactory::describeInContext( OFX::ImageEffectDescriptor& desc,
OFX::EContext context )
{
OFX::ClipDescriptor* srcClip = desc.defineClip( kOfxImageEffectSimpleSourceClipName );
srcClip->addSupportedComponent( OFX::ePixelComponentRGBA );
srcClip->addSupportedComponent( OFX::ePixelComponentAlpha );
srcClip->setSupportsTiles( kSupportTiles );
// Create the mandated output clip
OFX::ClipDescriptor* dstClip = desc.defineClip( kOfxImageEffectOutputClipName );
dstClip->addSupportedComponent( OFX::ePixelComponentRGBA );
dstClip->addSupportedComponent( OFX::ePixelComponentAlpha );
dstClip->setSupportsTiles( kSupportTiles );
//////////////////// Options ////////////////////
OFX::ChoiceParamDescriptor* method = desc.defineChoiceParam( kParamMethod );
method->setLabel( "Method" );
method->appendOption( kParamMethodAffine );
method->appendOption( kParamMethodPerspective );
method->appendOption( kParamMethodBilinear );
method->setDefault( 1 );
method->setHint( "Interpolation method" );
OFX::ChoiceParamDescriptor* interpolation = desc.defineChoiceParam( kParamInterpolation );
interpolation->setLabel( "Interpolation" );
interpolation->appendOption( kParamInterpolationNearest );
interpolation->appendOption( kParamInterpolationBilinear );
interpolation->setDefault( 1 );
interpolation->setHint( "Interpolation method" );
OFX::PushButtonParamDescriptor* setToCornersIn = desc.definePushButtonParam( kParamSetToCornersIn);
setToCornersIn->setLabel( "Set In" );
setToCornersIn->setHint("Set to corners in points");
OFX::PushButtonParamDescriptor* setToCornersOut = desc.definePushButtonParam( kParamSetToCornersOut);
setToCornersOut->setLabel( "Set Out" );
setToCornersOut->setHint("Set to corners out points");
OFX::BooleanParamDescriptor* overlay = desc.defineBooleanParam( kParamOverlay );
overlay->setLabel( "Overlay" );
overlay->setDefault( true );
OFX::BooleanParamDescriptor* inverse = desc.defineBooleanParam( kParamInverse );
inverse->setLabel( "Inverse" );
inverse->setDefault( false );
/*
//TODO-vince///////////
//////////////////// Transform Centre Point ////////////////////
OFX::GroupParamDescriptor* groupCentre = desc.defineGroupParam( kParamGroupCentre );
groupCentre->setLabel( "Centre point" );
groupCentre->setOpen(false);
OFX::ChoiceParamDescriptor* manipulatorMode = desc.defineChoiceParam( kParamManipulatorMode );
manipulatorMode->appendOption( kParamManipulatorModeTranslate );
manipulatorMode->appendOption( kParamManipulatorModeRotate );
manipulatorMode->appendOption( kParamManipulatorModeScale );
OFX::Double2DParamDescriptor* pCentre = desc.defineDouble2DParam( kParamPointCentre);
pCentre->setLabel( "Centre point" );
pCentre->setHint( "Transform Centre point" );
pCentre->setDefault( 0.0, 0.0 );
pCentre->setParent( groupCentre );
OFX::BooleanParamDescriptor* overlayCentre = desc.defineBooleanParam( kParamOverlayCentre );
overlayCentre->setLabel( "Overlay" );
overlayCentre->setDefault( true );
overlayCentre->setParent( groupCentre );
OFX::RGBParamDescriptor* ouverlayCentreColor = desc.defineRGBParam( kParamOverlayCentreColor );
ouverlayCentreColor->setLabel( "Color" );
ouverlayCentreColor->setHint( "Centre point overlay color" );
ouverlayCentreColor->setDefault( 0.0, 1.0, 0.0 );
ouverlayCentreColor->setParent( groupCentre );
*/
//////////////////// IN Points ////////////////////
OFX::GroupParamDescriptor* groupIn = desc.defineGroupParam( kParamGroupIn );
groupIn->setLabel( "Input points" );
groupIn->setOpen(false);
OFX::Double2DParamDescriptor* pIn0 = desc.defineDouble2DParam( kParamPointIn + "0" );
pIn0->setLabel( "In 0" );
pIn0->setHint( "Input point 0" );
pIn0->setDefault( -0.5, -0.5 );
pIn0->setParent( groupIn );
OFX::Double2DParamDescriptor* pIn1 = desc.defineDouble2DParam( kParamPointIn + "1" );
pIn1->setLabel( "In 1" );
pIn1->setHint( "Input point 1" );
pIn1->setDefault( 0.5, -0.5 );
pIn1->setParent( groupIn );
OFX::Double2DParamDescriptor* pIn2 = desc.defineDouble2DParam( kParamPointIn + "2" );
pIn2->setLabel( "In 2" );
pIn2->setHint( "Input point 2" );
pIn2->setDefault( -0.5, 0.5 );
pIn2->setParent( groupIn );
OFX::Double2DParamDescriptor* pIn3 = desc.defineDouble2DParam( kParamPointIn + "3" );
pIn3->setLabel( "In 3" );
pIn3->setHint( "Input point 3" );
pIn3->setDefault( 0.5, 0.5 );
pIn3->setParent( groupIn );
OFX::BooleanParamDescriptor* overlayIn = desc.defineBooleanParam( kParamOverlayIn );
overlayIn->setLabel( "Overlay" );
overlayIn->setDefault( true );
overlayIn->setParent( groupIn );
OFX::RGBParamDescriptor* ouverlayInColor = desc.defineRGBParam( kParamOverlayInColor );
ouverlayInColor->setLabel( "Color" );
ouverlayInColor->setHint( "Input point overlay color" );
ouverlayInColor->setDefault( 1.0, 0.0, 0.0 );
ouverlayInColor->setParent( groupIn );
//////////////////// OUT Points ////////////////////
OFX::GroupParamDescriptor* groupOut = desc.defineGroupParam( kParamGroupOut );
groupOut->setLabel( "Output points" );
groupOut->setOpen(false);
OFX::Double2DParamDescriptor* pOut0 = desc.defineDouble2DParam( kParamPointOut + "0" );
pOut0->setLabel( "Out 0" );
pOut0->setHint( "Output point 0" );
pOut0->setDefault( -0.5, -0.5 );
pOut0->setParent( groupOut );
OFX::Double2DParamDescriptor* pOut1 = desc.defineDouble2DParam( kParamPointOut + "1" );
pOut1->setLabel( "Out 1" );
pOut1->setHint( "Output point 1" );
pOut1->setDefault( 0.5, -0.5 );
pOut1->setParent( groupOut );
OFX::Double2DParamDescriptor* pOut2 = desc.defineDouble2DParam( kParamPointOut + "2" );
pOut2->setLabel( "Out 2" );
pOut2->setHint( "Output point 2" );
pOut2->setDefault( -0.5, 0.5 );
pOut2->setParent( groupOut );
OFX::Double2DParamDescriptor* pOut3 = desc.defineDouble2DParam( kParamPointOut + "3" );
pOut3->setLabel( "Out 3" );
pOut3->setHint( "Output point 3" );
pOut3->setDefault( 0.5, 0.5 );
pOut3->setParent( groupOut );
OFX::BooleanParamDescriptor* overlayOut = desc.defineBooleanParam( kParamOverlayOut );
overlayOut->setLabel( "Overlay" );
overlayOut->setDefault( true );
overlayOut->setParent( groupOut );
OFX::RGBParamDescriptor* ouverlayOutColor = desc.defineRGBParam( kParamOverlayOutColor );
ouverlayOutColor->setLabel( "Color" );
ouverlayOutColor->setHint( "Output point overlay color" );
ouverlayOutColor->setDefault( 0.0, 0.0, 1.0 );
ouverlayOutColor->setParent( groupOut );
//////////////////// Persp Matrix ////////////////////
OFX::GroupParamDescriptor* groupPerspMatrix = desc.defineGroupParam( kParamGroupPerspMatrix );
groupPerspMatrix->setLabel( "Perspective matrix" );
groupPerspMatrix->setHint( "Transformation matrix" );
OFX::Double3DParamDescriptor* perspMatrixRow0 = desc.defineDouble3DParam( kParamPerspMatrixRow + "0" );
perspMatrixRow0->setLabel( "row 0" );
perspMatrixRow0->setDefault( 1.0, 0.0, 0.0 );
perspMatrixRow0->setParent( groupPerspMatrix );
OFX::Double3DParamDescriptor* perspMatrixRow1 = desc.defineDouble3DParam( kParamPerspMatrixRow + "1" );
perspMatrixRow1->setLabel( "row 1" );
perspMatrixRow1->setDefault( 0.0, 1.0, 0.0 );
perspMatrixRow1->setParent( groupPerspMatrix );
OFX::Double3DParamDescriptor* perspMatrixRow2 = desc.defineDouble3DParam( kParamPerspMatrixRow + "2" );
perspMatrixRow2->setLabel( "row 2" );
perspMatrixRow2->setDefault( 0.0, 0.0, 1.0 );
perspMatrixRow2->setParent( groupPerspMatrix );
////////////////// Bilinear Matrix ////////////////////
OFX::GroupParamDescriptor* groupBilMatrix = desc.defineGroupParam( kParamGroupBilinearMatrix );
groupBilMatrix->setLabel( "Bilinear matrix" );
groupBilMatrix->setHint( "Billinear transformation matrix" );
OFX::Double2DParamDescriptor* bilMatrixRow0 = desc.defineDouble2DParam( kParamBilinearMatrixRow + "0" );
bilMatrixRow0->setLabel( "row 0" );
bilMatrixRow0->setDefault( 1.0, 0.0 );
bilMatrixRow0->setParent( groupBilMatrix );
OFX::Double2DParamDescriptor* bilMatrixRow1 = desc.defineDouble2DParam( kParamBilinearMatrixRow + "1" );
bilMatrixRow1->setLabel( "row 1" );
bilMatrixRow1->setDefault( 0.0, 1.0 );
bilMatrixRow1->setParent( groupBilMatrix );
OFX::Double2DParamDescriptor* bilMatrixRow2 = desc.defineDouble2DParam( kParamBilinearMatrixRow + "2" );
bilMatrixRow2->setLabel( "row 2" );
bilMatrixRow2->setDefault( 0.0, 0.0 );
bilMatrixRow2->setParent( groupBilMatrix );
OFX::Double2DParamDescriptor* bilMatrixRow3 = desc.defineDouble2DParam( kParamBilinearMatrixRow + "3" );
bilMatrixRow3->setLabel( "row 3" );
bilMatrixRow3->setDefault( 0.0, 0.0 );
bilMatrixRow3->setParent( groupBilMatrix );
}