Protocol

FxParameterCreationAPI

The FxParameterCreationAPI protocol defines the methods provided by the host application to create parameters.

Declaration

@protocol FxParameterCreationAPI

Overview

This is FxParameterCreationAPI protocol version 1.0.

A plug-in uses the methods defined in this protocol (along with those defined in FxOptionalParameterRetrievalAPI and FxOptionalParameterSettingAPI) to populate its parameter list. Each parameter is created with a unique numeric parameter ID.

The host application uses this parameter ID to identify a parameter, and stores the parameter ID in a saved project file. If a new version of a plug-in removes a parameter, the host application will then ignore any saved parameter data for that obsolete parameter in a project that was saved while using the old version of the plug-in. This implies that a new version plug-in should never change the ID of a given parameter unless it intentionally wants to obsolesce old value data in saved projects. Similarly, it should not introduce a new parameter with an ID that has already been made obsolete.

Topics

Grouping Parameters

- startParameterSubGroup:parmId:parmFlags:

Starts a new parameter subgroup.

Required.

- endParameterSubGroup

Closes current parameter subgroup.

Required.

Adding Parameter Controls

- addAngleSliderWithName:parmId:defaultValue:parameterMin:parameterMax:parmFlags:

Creates an angle slider parameter and adds it to the plug-in's parameter list.

Required.

- addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parmFlags:

Creates an RGBA color value and adds it to the plug-in's parameter list.

Required.

- addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:parmFlags:

Creates an RGB color parameter and adds it to the plug-in's parameter list.

Required.

- addCustomParameterWithName:parmId:defaultValue:parmFlags:

Creates a custom parameter and adds it to the plug-in's parameter list.

Required.

- addFloatSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags:

Creates a floating point slider parameter and adds it to the plug-in's parameter list.

Required.

- addImageReferenceWithName:parmId:parmFlags:

Creates an image reference parameter and adds it to the plug-in's parameter list.

Required.

- addIntSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags:

Creates an integer slider parameter and adds it to the plug-in's parameter list.

Required.

- addPointParameterWithName:parmId:defaultX:defaultY:parmFlags:

Creates a position point parameter and adds it to the plug-in's parameter list.

Required.

- addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags:

Creates a popup menu parameter and adds it to the plug-in's parameter list.

Required.

- addToggleButtonWithName:parmId:defaultValue:parmFlags:

Creates a checkbox toggle button parameter and adds it to the plug-in's parameter list.

Required.

Constants

FxParameterFlags

These constants specify the characteristics of parameters display.

Group Expansion Parameter Flag

The following constant is provided for backward compatibility.

Relationships