FxParameterCreationAPI

FxParameterCreationAPI протокол определяет методы, предоставленные хост-приложением для создания параметров.

Это FxParameterCreationAPI версия протокола 1.0.

Плагин использует методы, определенные в этом протоколе (вместе с определенными в Ссылке на протокол Ссылки на протокол и FxOptionalParameterSettingAPI FxOptionalParameterRetrievalAPI) для заполнения ее списка параметров. Каждый параметр создается с уникальным числовым параметром ID.

Хост-приложение использует этот параметр ID для идентификации параметра и хранит параметр ID в сохраненном файле проекта. Если новая версия плагина удалит параметр, то хост-приложение тогда проигнорирует любые сохраненные данные параметра для того устаревшего параметра в проекте, сохраненном при использовании старой версии плагина. Это подразумевает, что новый плагин версии никогда не должен изменять ID данного параметра, если он преднамеренно не хочет перестать использовать старые данные значения в сохраненных проектах. Точно так же это не должно начинать новый параметр с ID, уже сделанного устаревшим.

Наследование

Не применимый

Соответствует

Не применимый

Оператор импорта

Не применимый не применимый

Группировка параметров


    
    startParameterSubGroup:parmId:parmFlags:
    - startParameterSubGroup:parmId:parmFlags:

Требуемый

Запускает новую подгруппу параметра. (требуемый)

Объявление

Objective C

- (BOOL)startParameterSubGroup:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает подгруппу параметра; иначе NOfalse.

Обсуждение

Все последующие дополнения параметра помещаются в эту группу, пока Вы не отправляете endParameterSubGroup сообщение.

endParameterSubGroup - endParameterSubGroup Требуемый

Завершения текущая подгруппа параметра. (требуемый)

Объявление

Objective C

- (BOOL)endParameterSubGroup

Возвращаемое значение

Возвраты YEStrue если приложение успешно закрывает текущую подгруппу параметра; иначе NOfalse.

Обсуждение

Необходимо всегда соединять это с предыдущим startParameterSubGroup:parmId:parmFlags: сообщение.

Добавление средств управления параметром


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

Требуемый

Создает угловой параметр ползунка и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (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`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает угловой параметр ползунка; иначе NOfalse.

Обсуждение

min и max значения выражены в радианах, в то время как defaultValue выражен в градусах. Удите рыбу значения параметров должны быть получены с помощью getFloatValue:fromParm:atTime: (а не осуждаемый getAngle: метод), и выражены в против часовой стрелки градусах.

До FxPlug SDK 1.2 документация для этого метода имела модули (градусы и радианы) инвертированный. Документация была исправлена, реализация не изменилась.

См. также


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

Требуемый

Создает ценность цвета RGBA и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (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`	Начальное красное значение параметра в плавании (0.0 - 1.0) пространство.
`green`	Начальное зеленое значение параметра в плавании (0.0 - 1.0) пространство.
`blue`	Начальное синее значение параметра в плавании (0.0 - 1.0) пространство.
`alpha`	Начальное альфа-значение параметра в плавании (0.0 - 1.0) пространство.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр цвета RGBA; иначе NOfalse.

См. также


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

Требуемый

Создает параметр цвета RGB и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addColorParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultRed:(double)red defaultGreen:(double)green defaultBlue:(double)blue parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`red`	Начальное красное значение параметра в плавании (0.0 - 1.0) пространство.
`green`	Начальное зеленое значение параметра в плавании (0.0 - 1.0) пространство.
`blue`	Начальное синее значение параметра в плавании (0.0 - 1.0) пространство.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр цвета RGB; иначе NOfalse.

См. также


    
    addCustomParameterWithName:parmId:defaultValue:parmFlags:
    - addCustomParameterWithName:parmId:defaultValue:parmFlags:

Требуемый

Создает пользовательский параметр и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addCustomParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(id<NSCoding>)defaultValue parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`defaultValue`	Начальная запись для параметра.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает пользовательский параметр; иначе NOfalse.

Обсуждение

defaultValue параметром является экземпляр, создаваемый плагином, класса пользовательского параметра, который должен соответствовать NSCoding протокол. NSCoding протокол используется для сериализированного и не сериализирующего объект значения пользовательского параметра для сохранения и загрузки.

См. также


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

Требуемый

Создает параметр ползунка с плавающей точкой и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (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`	Сигареты, кодирующие различные значения состояния для параметра. Использовать `kFxParameterFlag_IGNORE_MINMAX` создать ползунок с неограниченным диапазоном. В этом случае, `min`, `max`, `sliderMin`, и `sliderMax` значения проигнорированы.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр ползунка с плавающей точкой; иначе NOfalse.

Обсуждение

Final Cut Pro не поддерживает отдельный min и max для ползунка и параметра.

См. также

– addAngleSliderWithName:parmId:defaultValue:parameterMin:parameterMax:parmFlags:
– addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parmFlags:
– addColorParameterWithName:parmId:defaultRed:defaultGreen:defaultBlue:parmFlags:
– addCustomParameterWithName:parmId:defaultValue:parmFlags:
– addImageReferenceWithName:parmId:parmFlags:
– addIntSliderWithName:parmId:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parmFlags:
– addPointParameterWithName:parmId:defaultX:defaultY:parmFlags:
– addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags:
– addToggleButtonWithName:parmId:defaultValue:parmFlags:


    
    addImageReferenceWithName:parmId:parmFlags:
    - addImageReferenceWithName:parmId:parmFlags:

Требуемый

Создает параметр ссылки изображения и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addImageReferenceWithName:(NSString *)name parmId:(UInt32)parmId parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр ссылки изображения; иначе NOfalse.

См. также


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

Требуемый

Создает целочисленный параметр ползунка и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (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`	Флаги, кодирующие различные значения состояния для параметра. Использовать `kFxParameterFlag_IGNORE_MINMAX` создать ползунок с неограниченным диапазоном. В этом случае минута, макс., sliderMin, и значения sliderMax проигнорированы.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает целочисленный параметр ползунка; иначе NOfalse.

Обсуждение

Final Cut Pro не поддерживает отдельный min и max для ползунка и параметра

См. также


    
    addPointParameterWithName:parmId:defaultX:defaultY:parmFlags:
    - addPointParameterWithName:parmId:defaultX:defaultY:parmFlags:

Требуемый

Создает параметр точки позиции и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addPointParameterWithName:(NSString *)name parmId:(UInt32)parmId defaultX:(double)defaultX defaultY:(double)defaultY parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`defaultX`	Начальная буква X значений параметра позиции в плавании (0.0 - 1.0 от нижней левой части) пространство.
`defaultY`	Начальная буква Y значение параметра позиции в плавании (0.0 - 1.0 от нижней левой части) пространство.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр позиции; иначе NOfalse.

См. также


    
    addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags:
    - addPopupMenuWithName:parmId:defaultValue:menuEntries:parmFlags:

Требуемый

Создает параметр всплывающего меню и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addPopupMenuWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(UInt32)defaultValue menuEntries:(NSArray *)entries parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`defaultValue`	Индекс начальной записи для параметра.
`entries`	Массив Нсстрингса, представляющего записи в меню.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает всплывающее меню; иначе NOfalse.

См. также


    
    addToggleButtonWithName:parmId:defaultValue:parmFlags:
    - addToggleButtonWithName:parmId:defaultValue:parmFlags:

Требуемый

Создает параметр выключателя флажка и добавляет его к списку параметров плагина. (требуемый)

Объявление

Objective C

- (BOOL)addToggleButtonWithName:(NSString *)name parmId:(UInt32)parmId defaultValue:(BOOL)defaultValue parmFlags:(FxParameterFlags)flags

Параметры

`name`	Имя параметра в пользовательском интерфейсе.
`parmId`	Уникальный идентификатор для параметра. Используемый для получения установите или проверьте параметр.
`defaultValue`	Начальное значение для параметра.
`flags`	Флаги, кодирующие различные значения состояния для параметра.

Возвращаемое значение

Возвраты YEStrue если приложение успешно создает параметр переключателя; иначе NOfalse.

См. также

Константы

Флаги дисплея параметра
Эти константы указывают характеристики дисплея параметров.

Объявление

Objective C

enum { kFxParameterFlag_DEFAULT = 0, kFxParameterFlag_NOT_ANIMATABLE = 1 << 0, kFxParameterFlag_HIDDEN = 1 << 1, kFxParameterFlag_DISABLED = 1 << 2, kFxParameterFlag_COLLAPSED = 1 << 3, kFxParameterFlag_DONT_SAVE = 1 << 4, kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD = 1 << 5, kFxParameterFlag_CUSTOM_UI = 1 << 6, kFxParameterFlag_IGNORE_MINMAX = 1 << 8, }; typedef UInt32 FxParameterFlags;

Константы
- kFxParameterFlag_DEFAULT
  
  kFxParameterFlag_DEFAULT
  
  Постоянное удобство. Никакие флаги не установлены.
- kFxParameterFlag_NOT_ANIMATABLE
  
  kFxParameterFlag_NOT_ANIMATABLE
  
  Значение этого параметра является постоянным через время и не может быть анимировано.
- kFxParameterFlag_HIDDEN
  
  kFxParameterFlag_HIDDEN
  
  Этот параметр не выводит на экран UI пользователю, но его значение сохраняется/загружается. Обратите внимание на то, что это управление видимостью независимо от kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD флаг. Возможно иметь параметр, появляющийся в инструментальной панели, но не в инспекторе, или наоборот.
- kFxParameterFlag_DISABLED
  
  kFxParameterFlag_DISABLED
  
  Этот параметр недоступен и отключен.
- kFxParameterFlag_COLLAPSED
  
  kFxParameterFlag_COLLAPSED
  
  Эта подгруппа параметра группы закрывается, и ее подпараметры не видимы в Инспекторе.
- kFxParameterFlag_DONT_SAVE
  
  kFxParameterFlag_DONT_SAVE
  
  Значения этого параметра не сохраняются или загружаются.
- kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD
  
  kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD
  
  Этот параметр не видим в средствах управления инструментальной панелью.
- kFxParameterFlag_CUSTOM_UI
  
  kFxParameterFlag_CUSTOM_UI
  
  Этот параметр использует настроенный пользовательский интерфейс, заменяющий стандартный параметр UI. Плагин должен обеспечить пользовательское представление для этого параметра. Посмотрите Ссылку на протокол Ссылки на протокол и FxCustomParameterViewHost FxCustomParameterActionAPI.
- kFxParameterFlag_IGNORE_MINMAX
  
  kFxParameterFlag_IGNORE_MINMAX
  
  Диапазон этого параметра неограничен. Проигнорируйте его минимальные и максимальные значения.
Обсуждение

Не все флаги обоснованно ко всем типам параметра. Единственные флаги, например, которые применяются к параметрам группы, kFxParameterFlag_COLLAPSED, kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD, kFxParameterFlag_HIDDEN, и kFxParameterFlag_DISABLED.

Вы неспособны дать параметру группы настроенный пользовательский интерфейс.
Флаг параметра расширения группы
Следующая константа предоставлена для обратной совместимости.

Объявление

Objective C

#define kFxParameterFlag_EXPANDED kFxParameterFlag_COLLAPSED

Константы
- kFxParameterFlag_EXPANDED
  
  kFxParameterFlag_EXPANDED
  
  FxPlug SDK 1.0 неверно назвал флаг, указывающий, что разрушен параметр группы. Новые плагины должны использовать kFxParameterFlag_COLLAPSED вместо kFxParameterFlag_EXPANDED.