FxKeyframeAPI

FxKeyframeAPI протокол определяет методы хост-приложения, позволяющие плагинам устанавливать и получать ключевые кадры для параметров, которые они имеют.

Используя FxKeyframeAPI плагины могут запросить хост-приложение, чтобы узнать, существуют ли ключевые кадры и если так, сколько существует, какие времена они размещаются в, и что оценивает параметры, имеют в тех ключевых кадрах. Это также позволяет плагинам создавать новые ключевые кадры с требуемым значением в любой момент времени.

Этот протокол был представлен в FxPlug SDK 2.0.

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

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

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

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

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

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

Изменение ключевых кадров


    
    addKeyframe:toParam:andChannel:
    - addKeyframe:toParam:andChannel:

Требуемый

Добавляет ключевой кадр в данное (требуемое) время

Объявление

Objective C

- (NSError*)addKeyframe:(FxKeyframeInfo)info toParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`info`	Указатель на `FxKeyframeInfo` структура, чтобы быть заполненным информацией о рассматриваемом ключевом кадре.
`paramID`	ID параметра, для которого запрошена информация.
`channelIndex`	Индекс ключевого кадра, к которому должна быть добавлена информация.

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

NSError возразите, перестал ли метод работать; иначе NIL.

Обсуждение

Для параметров, только имеющих один канал (ползунки, угловые кнопки, флажки, и т.д.) channelIndex будет 0. Для составных параметров это будет подканал. Например, если бы Вы желаете к ключевому кадру красного канала цвета, это был бы индекс канала 0, тогда как зеленый канал был бы индексом канала 1, и т.д.


    
    channelCount:forParam:
    - channelCount:forParam:

Требуемый

Возвращает число каналов в параметре. (требуемый)

Объявление

Objective C

- (NSError*)channelCount:(UInt32*)count forParam:(UInt32)paramID

Параметры

`count`	Возвраты, ссылкой, число каналов в `paramID` (ползунки = 1, 2D точки = 2, RGBA окрашивает = 4, и т.д.) в параметре количества.
`paramID`	ID параметра, каналы которого Вы хотите считать.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    keyframeCount:forParam:andChannel:
    - keyframeCount:forParam:andChannel:

Требуемый

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

Объявление

Objective C

- (NSError*)keyframeCount:(UInt32*)count forParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`count`	Возвраты, ссылкой, число ключевых кадров в данном канале.
`paramID`	ID параметра Вы хотите получить счет ключевого кадра.
`channelIndex`	Индекс канала в параметре, от которого Вы хотите получить количество ключевого кадра.

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

NSError возразите, перестал ли метод работать; иначе NIL.

Обсуждение

Учитывая параметр, можно получить число ключевых кадров для любого из его каналов.

Для ползунка, выключатель (флажок) или угловой параметр, будет только один канал (индексированный запуск в 0), тогда как параметр точки будет иметь два канала (x и y), и цветовой канал будет иметь четыре канала (R, G, B, и A).


    
    keyframeInfo:atOrAfter:fromParam:andChannel:
    - keyframeInfo:atOrAfter:fromParam:andChannel:

Требуемый

Возвращает информацию о самом близком следующем ключевом кадре. (требуемый)

Объявление

Objective C

- (NSError*)keyframeInfo:(FxKeyframeInfo*)info atOrAfter:(double)time fromParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`info`	Указатель на `FxKeyframeInfo` структура, чтобы быть заполненным информацией о требуемом ключевом кадре.
`time`	Время для, для которого ключевой кадр требуется или самый близкий более поздний ключевой кадр.
`paramID`	ID параметра, для которого Вы хотите информацию о ключевом кадре.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    keyframeInfo:atOrBefore:fromParam:andChannel:
    - keyframeInfo:atOrBefore:fromParam:andChannel:

Требуемый

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

Объявление

Objective C

- (NSError*)keyframeInfo:(FxKeyframeInfo*)info atOrBefore:(double)time fromParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`info`	Указатель на a `FxKeyframeInfo` который будет содержать информацию о ключевом кадре в или перед данным временем.
`time`	Время для, для которого ключевой кадр требуется или самый близкий более ранний ключевой кадр.
`paramID`	ID параметра, для которого Вы хотите информацию о ключевом кадре.
`channelIndex`	ID параметра для получить информацию о ключевом кадре.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    keyframeInfo:forParam:channel:andIndex:
    - keyframeInfo:forParam:channel:andIndex:

Требуемый

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

Объявление

Objective C

- (NSError*)keyframeInfo:(FxKeyframeInfo*)info forParam:(UInt32)paramID channel:(UInt32)channelIndex andIndex:(UInt32)keyframeIndex

Параметры

`info`	Указатель на `FxKeyframeInfo` структура, чтобы быть заполненным информацией о требуемом ключевом кадре.
`paramID`	ID параметра, для которого запрашивается информация.
`channelIndex`	Индекс канала, для которого запрашивается информация.
`keyframeIndex`	Индекс ключевого кадра, который будет получен.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    param:channel:hasKeyframe:atTime:
    - param:channel:hasKeyframe:atTime:

Требуемый

Говорит, существует ли ключевой кадр в установленный срок. (требуемый)

Объявление

Objective C

- (NSError*)param:(UInt32)paramID channel:(UInt32)channelIndex hasKeyframe:(BOOL*)hasKeyframe atTime:(double)time

Параметры

`paramID`	ID параметра, для которого запрашивается информация.
`channelIndex`	Индекс канала, для которого запрашивается информация.
`hasKeyframe`	Возвраты, ссылкой, имеют ли каналы указанного параметра ключевой кадр в требуемое время.
`time`	Время ключевого кадра.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    removeAllKeyframesForParam:andChannel:
    - removeAllKeyframesForParam:andChannel:

Требуемый

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

Объявление

Objective C

- (NSError*)removeAllKeyframesForParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`paramID`	ID параметра ключевых кадров для удаления.
`channelIndex`	Индекс канала параметра, ключевые кадры которого Вы хотите удалить.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    removeKeyframeAtIndex:fromParam:andChannel:
    - removeKeyframeAtIndex:fromParam:andChannel:

Требуемый

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

Объявление

Objective C

- (NSError*)removeKeyframeAtIndex:(UInt32)keyframeIndex fromParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`keyframeIndex`	Индекс ключевого кадра для удаления.
`paramID`	ID параметра, для которого можно удалить ключевой кадр.
`channelIndex`	Индекс параметра образовывает канал, для которого должен быть удален ключевой кадр.

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

NSError возразите, перестал ли метод работать; иначе NIL.


    
    setKeyframe:withInfo:forParam:andChannel:
    - setKeyframe:withInfo:forParam:andChannel:

Требуемый

Устанавливает ключевой кадр в данном индексе для имения данной (требуемой) информации

Объявление

Objective C

- (NSError*)setKeyframe:(UInt32)keyframeIndex withInfo:(FxKeyframeInfo)info forParam:(UInt32)paramID andChannel:(UInt32)channelIndex

Параметры

`keyframeIndex`	Индекс ключевого кадра для установки.
`info`	`FxKeyframeInfo` структура с информацией для применения к ключевому кадру.
`paramID`	ID параметра к, для которого можно установить ключевой кадр.
`channelIndex`	Индекс канала параметра, в который можно установить ключевой кадр.

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

NSError возразите, перестал ли метод работать; иначе NIL.

Типы данных

Структура ключевого кадра Структура ключевого кадра
Содержит информацию об отдельном ключевом кадре.

Объявление

Objective C

typedef struct FxKeyframeInfo { int version; double time; FxKeyframeStyle style; double inTangentX; double inTangentY; double outTangentX; double outTangentY; } FxKeyframeInfo;

Константы
- version
  
  version
  
  Версия этой структуры.
- time
  
  time
  
  Время ключевого кадра.
- style
  
  style
  
  Тип ключевого кадра.
- inTangentX
  
  inTangentX
  
  Координата x входящей касательной.
- inTangentY
  
  inTangentY
  
  Координата y входящей касательной.
- outTangentX
  
  outTangentX
  
  Координата x исходящей касательной.
- outTangentY
  
  outTangentY
  
  Координата y исходящей касательной.
Оператор импорта

Константы

Макрос FxInitKeyframeInfo
Этот макрос гарантирует, что информационная структура ключевого кадра должным образом инициализируется для текущей версии плагина.

Объявление

Objective C

#define FxInitKeyframeInfo (ki) { memset(&ki, 0, sizeof(ki)); ki.version=kFxKeyframeInfo_CurrentVersion; }

Константы
- FxInitKeyframeInfo
  
  FxInitKeyframeInfo
  
  Передача kFxKeyframeInfo_CurrentVersion создать соответственно инициализированную структуру.
Информация о версии ключевого кадра
Указывает версию информации ключевого кадра.

Объявление

Objective C

#define kFxKeyframeInfo_V1 1 #define kFxKeyframeInfo_CurrentVersion kFxKeyframeInfo_V1

Константы
- kFxKeyframeInfo_V1
  
  kFxKeyframeInfo_V1
  
  Номер версии информации о ключевом кадре.
- kFxKeyframeInfo_CurrentVersion
  
  kFxKeyframeInfo_CurrentVersion
  
  Используемый для определения информационной структуры ключевого кадра, как являющейся самой актуальной версией.
Обсуждение

kFxKeyframeInfo_CurrentVersion определение является текущей версией для плагина FxPlug SDK, создается для. Для текущего выпуска это будет 1. Когда разработчики создают FxKeyframeInfo структура, они должны всегда устанавливать поле версии в kFxKeyframeInfo_CurrentVersion (если они не пытаются работать в более старом узле), использование Макроса FxInitKeyframeInfo.