|
ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference
|
FxParameterCreationAPI |
| Declared In: |
Defines the methods provided by the host application to create parameters.
This is version 1 of the FxParameterCreationAPI protocol.
A plug-in uses the methods defined in this protocol (along with those defined
in FxOptionalParameterAPI.h) 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 obsolesced.
addAngleSliderWithName:parmId:defaultValue:parameterMin:parameterMax:parmFlags: |
Creates an angle slider parameter and adds it to the plug-in's parameter list.
- (BOOL)addAngleSliderWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(double)defaultValue parameterMin:(double)min parameterMax:(double)max parmFlags:(FxParameterFlags)flags;
name parmId defaultValue min max flags Returns YES if the application successfully creates an angle slider parameter; NO otherwise.
The min and max values are expressed in radians, while the defaultValue is
expressed in degrees. Angle parameter values should be retrieved using the
-getFloatValue: (rather than the deprecated getAngle: method), and are expressed
in counter-clockwise degrees.
Prior to FxPlug 1.2, the documentation for this method had the units (degrees
and radians) reversed. However, the implementation has not changed.
addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parmFlags: |
Creates an RGBA color value and adds it to the plug-in's parameter list.
- (BOOL)addColorParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultRed:(double)red defaultGreen:(double)green defaultBlue:(double)blue defaultAlpha:(double)alpha parmFlags:(FxParameterFlags)flags;
name parmId red green blue alpha flags Returns YES if the application successfully creates an RGBA color parameter; NO otherwise.
addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:parmFlags: |
Creates an RGB color parameter and adds it to the plug-in's parameter list.
- (BOOL)addColorParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultRed:(double)red defaultGreen:(double)green defaultBlue:(double)blue parmFlags:(FxParameterFlags)flags;
name parmId red green blue flags Returns YES if the application successfully creates an RGB color parameter; NO otherwise.
addCustomParameterWithName:parmId:defaultValue:parmFlags: |
Creates a custom parameter and adds it to the plug-in's parameter list.
- (BOOL)addCustomParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(id<NSCoding>)defaultValue parmFlags:(FxParameterFlags)flags;
name parmId defaultValue flags Returns YES if the application successfully creates a custom parameter; NO otherwise.
The defaultValue argument is an instance, created by the plug-in, of the custom
parameter's class, which must conform to the NSCoding protocol. NSCoding is used
for serialized and unserializing the custom parameter's value object for saving
and loading.
NOTE: Your implementation of the NSCoding methods (-encodeWithCoder: and
-initWithCoder:) must use keyed coding.
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.
- (BOOL)addFloatSliderWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(double)defaultValue parameterMin:(double)min parameterMax:(double)max sliderMin:(double)sliderMin sliderMax:(double)sliderMax delta:(double)sliderDelta parmFlags:(FxParameterFlags)flags;
name parmId defaultValue min max sliderMin sliderMax sliderDelta flags Returns YES if the application successfully creates a floating point slider parameter; NO otherwise.
addImageReferenceWithName:parmId:parmFlags: |
Creates an image reference parameter and adds it to the plug-in's parameter list.
- (BOOL)addImageReferenceWithName:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags;
name parmId flags Returns YES if the application successfully creates an image reference parameter; NO otherwise.
addIntSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags: |
Creates an integer slider parameter and adds it to the plug-in's parameter list.
- (BOOL)addIntSliderWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(int)defaultValue parameterMin:(int)min parameterMax:(int)max sliderMin:(int)sliderMin sliderMax:(int)sliderMax delta:(int)sliderDelta parmFlags:(FxParameterFlags)flags;
name parmId defaultValue min max sliderMin sliderMax sliderDelta flags Returns YES if the application successfully creates an integer slider parameter; NO otherwise.
addPointParameterWithName:parmId:defaultX:defaultY:parmFlags: |
Creates a position point parameter and adds it to the plug-in's parameter list.
- (BOOL)addPointParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultX:(double)defaultX defaultY:(double)defaultY parmFlags:(FxParameterFlags)flags;
name parmId defaultX defaultY flags Returns YES if the application successfully creates a position parameter; NO otherwise.
addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags: |
Creates a popup menu parameter and adds it to the plug-in's parameter list.
- (BOOL)addPopupMenuWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(UInt32)defaultValue menuEntries:(NSArray *)entries parmFlags:(FxParameterFlags)flags;
name parmId defaultValue entries flags Returns YES if the application successfully creates a popup menu; NO otherwise.
addToggleButtonWithName:parmId:defaultValue:parmFlags: |
Creates a checkbox toggle button parameter and adds it to the plug-in's parameter list.
- (BOOL)addToggleButtonWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(BOOL)defaultValue parmFlags:(FxParameterFlags)flags;
name parmId defaultValue flags Returns YES if the application successfully creates a toggle parameter; NO otherwise.
endParameterSubGroup |
Closes current parameter subgroup. You should always pair this with a preceding startParameterSubGroup message.
- (BOOL)endParameterSubGroup;
Returns YES if the application successfully closes the current parameter sub group; NO otherwise.
startParameterSubGroup:parmId:parmFlags: |
Starts a new parameter subgroup. All subsequent parameter additions are placed in this group until you send an endParameterSubGroup message.
- (BOOL)startParameterSubGroup:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags;
name parmId flags Returns YES if the application successfully creates a parameter sub group; NO otherwise.
|