FxPathAPI

FxPathAPI протокол обеспечивает интерфейс, что реализации хост-приложения для обеспечения получения информации о путях, формах, и маскируют пользователя, привлек объект.

Используйте этот протокол для получения информации о пути, что пользователь привлек объект в холсте. Можно добраться, число путей применилось к объекту, и затем перечислите через них или выберите определенного.

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

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

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

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

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

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

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

Получите информацию геометрии пути


    
    isPath:invertedAtTime:error:
    - isPath:invertedAtTime:error:

Требуемый

Говорит, инвертируется ли путь или не (требуется)

Объявление

Objective C

- (BOOL)isPath:(FxPathID)pathID invertedAtTime:(double)time error:(NSError**)err

Параметры

`pathID`	ID пути Вы хотите знать о
`time`	Время, в которое Вы хотите запросить путь
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при проверке пути.

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

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


    
    isPath:openAtTime:error:
    - isPath:openAtTime:error:

Требуемый

Говорит, открыт ли путь или закрыт (требуемый)

Объявление

Objective C

- (BOOL)isPath:(FxPathID)pathID openAtTime:(double)time error:(NSError**)err

Параметры

`pathID`	ID пути Вы хотите знать о
`time`	Время, в которое Вы хотите запросить путь
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при проверке пути.

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

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


    
    lengthOfPath:atTime:error:
    - lengthOfPath:atTime:error:

Требуемый

Возвращает длину всего (требуемого) пути

Объявление

Objective C

- (double)lengthOfPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`pathID`	ID пути к запросу
`time`	Время, в которое Вы хотите найти длину пути
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при проверке пути.

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

Возвращает длину (в пикселях) пути.


    
    lengthOfSegment:ofPath:atTime:error:
    - lengthOfSegment:ofPath:atTime:error:

Требуемый

Возвращает длину 1 сегмента всего (требуемого) пути

Объявление

Objective C

- (double)lengthOfSegment:(NSUInteger)segmentIndex ofPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`segmentIndex`	Какого сегмента пути Вы хотите оценить длину
`pathID`	ID пути, сегмент которого Вы хотите оценить
`time`	Время, в которое можно оценить длину сегмента пути
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при оценке длины сегмента пути.

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

Возвращает длину (в пикселях) segmentIndex из рассматриваемого пути.


    
    pointAtPercentageOfParameter:alongPath:atTime:error:
    - pointAtPercentageOfParameter:alongPath:atTime:error:

Требуемый

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

Объявление

Objective C

- (FxPoint2D)pointAtPercentageOfParameter:(double)percentParam alongPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`percentParam`	Процент вдоль пути, где Вы хотите найти точку.
`pathID`	ID пути Вы хотите запросить.
`time`	Время, в которое Вы хотите запросить путь.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился.

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

2D точка, содержащая расположение на пути, который является надлежащим параметрическим расстоянием вдоль пути. Если какие-либо ошибки произойдут, то они будут хранилищем в, допускают ошибку.

Обсуждение

Возвращает 2D точку, содержащую расположение точки на пути в, который является percentParam процент вдоль параметрического расстояния пути. Это не то же как процент расстояния вдоль пути. (Для этого используйте pointAtPercentageOfDistance:alongPath:atTime:error:) В областях высокого искривления вдоль пути, будет больший процент точек вдоль кривой в параметрическом пространстве, тогда как в областях низкого искривления, будет меньше точек вдоль кривой.

См. также

– pointAtPercentageOfDistance:alongPath:atTime:error:


    
    pointAtPercentageOfDistance:alongPath:atTime:error:
    - pointAtPercentageOfDistance:alongPath:atTime:error:

Требуемый

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

Объявление

Objective C

- (FxPoint2D)pointAtPercentageOfParameter:(double)percentParam alongPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`percentParam`	Процент расстояния вдоль пути, где Вы хотите найти точку.
`pathID`	ID пути Вы хотите запросить.
`time`	Время, в которое Вы хотите запросить путь.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился.

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

Возвращает 2D точку, содержащую расположение на пути, который является надлежащим расстоянием вдоль пути.

См. также

– pointAtPercentageOfParameter:alongPath:atTime:error:


    
    numberOfVerticesInPath:atTime:error:
    - numberOfVerticesInPath:atTime:error:

Требуемый

Возвращает число вершин по данному пути в данное (требуемое) время

Объявление

Objective C

- (NSUInteger)numberOfVerticesInPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`pathID`	ID пути к запросу
`time`	Время, в которое Вы хотите найти число вершин по пути
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при проверке пути.

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

Число вершин, которые содержит путь.


    
    vertex:atIndex:ofPath:atTime:error:
    - vertex:atIndex:ofPath:atTime:error:

Требуемый

Информация о возвратах о единственной вершине на пути в данное время. (требуемый)

Объявление

Objective C

- (void)vertex:(FxVertex*)vertex atIndex:(NSUInteger)index ofPath:(FxPathID)pathID atTime:(double)time error:(NSError**)err

Параметры

`vertex`	Указатель на структуру вершины для содержания информации о рассматриваемой вершине. Заполненная структура FxVertex возвращается с информацией о вершине в индексе, переданном в.
`index`	Индекс вершины Вы хотите получить. Если путь имеет, это на основе 0, поэтому `n` вершины, это будет между 0 и `n-1`.
`pathID`	ID пути, от которого Вы хотите получить вершину.
`time`	Время, в которое можно получить информацию о вершине.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился.

Получение и установка информации о пути


    
    blendModeOfPath:error:
    - blendModeOfPath:error:

Требуемый

Получает режим наложения для данного (требуемого) пути

Объявление

Objective C

- (FxPathBlendMode)blendModeOfPath:(FxPathID)pathID error:(NSError**)err

Параметры

`pathID`	ID пути, режим наложения которого Вы хотите получить.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при получении режима наложения.

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

Режим наложения пути с данным ID. Посмотрите Path Blending Mode для поддерживаемых значений.


    
    styleOfPath:error:
    - styleOfPath:error:

Требуемый

Возвращает стиль пути - линейный, bezier, или (требуемый) B-сплайн

Объявление

Objective C

- (FxPathStyle)styleOfPath:(FxPathID)pathID error:(NSError**)err

Параметры

`pathID`	ID пути к запросу
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился.

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

Возвращает стиль пути для рассматриваемого пути.

См. также

– setPath:color:error:


    
    setPath:color:error:
    - setPath:color:error:

Требуемый

Выбирает цвет использование приложения узла для рисования пути с данным ID. (требуемый)

Объявление

Objective C

- (void)setPath:(FxPathID)pathID color:(FxPathColor)newColor error:(NSError**)err

Параметры

`pathID`	ID пути Вы хотите нарисовать в различном цвете.
`newColor`	FxPathColor для использования для рисования пути в.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при выбирании цвета пути.

См. также

– styleOfPath:error:


    
    nameOfPath:error:
    - nameOfPath:error:

Требуемый

Возвращает имя, пользователь ввел для пути с данным (требуемым) ID

Объявление

Objective C

- (NSString*)nameOfPath:(FxPathID)pathID error:(NSError**)err

Параметры

`pathID`	ID пути, имя которого Вы хотите получить
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при получении имени пути.

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

Строка, содержащая имя пользователь, ввела для пути.

numberOfPathsAtTime: - numberOfPathsAtTime: Требуемый

Возвращает число путей на объекте, к которому Ваш фильтр применяется, или на Вашем генераторе. (требуемый)

Объявление

Objective C

- (NSUInteger)numberOfPathsAtTime:(double)time

Параметры

time

Время, в которое Вы хотите знать число путей.

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

Число путей, что Вашему фильтру применяются к в требуемое время.


    
    pathIDForIndex:error:
    - pathIDForIndex:error:

Требуемый

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

Объявление

Objective C

- (FxPathID)pathIDForIndex:(NSUInteger)index error:(NSError**)err

Параметры

`index`	Индекс, что Вы хотите ID. Это значение на основе 0, поэтому если существуют пути n, можно получить пути в индексах 0 через n-1.
`err`	Возвраты, ссылкой, `NSError` экземпляр, содержащий любые ошибки, встретился при попытке получить путь ID.

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

Возвращает ID пути в index.

Типы данных

Свойства вершины пути Свойства вершины пути
Определяет свойства одной вершины по пути.

Объявление

Objective C

typedef struct FxVertex { FxPoint2D location; FxPoint2D inTangent; FxPoint2D outTangent; double xSplineWeight; FxPathStyle interpStyle; } FxVertex;

Константы
- location
  
  location
  
  Расположение точки в 2D изображении.
- inTangent
  
  inTangent
  
  Векторы x и y входящей касательной.
- outTangent
  
  outTangent
  
  Векторы x и y исходящей касательной.
- xSplineWeight
  
  xSplineWeight
  
  Вес x-шлица в этой точке.
- interpStyle
  
  interpStyle
  
  Стиль интерполяции в этой вершине. Посмотрите Path Style для поддерживаемых значений.
Оператор импорта

Константы

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

Объявление

Objective C

enum { kFxPathBlendMode_Add = 0, kFxPathBlendMode_Subtract, kFxPathBlendMode_Replace, kFxPathBlendMode_Intersect }; typedef NSUInteger FxPathBlendMode;

Константы
- kFxPathBlendMode_Add
  
  kFxPathBlendMode_Add
  
  Маска смешает использование аддитивного режима.
- kFxPathBlendMode_Subtract
  
  kFxPathBlendMode_Subtract
  
  Маска смешает использование вычитать режима.
- kFxPathBlendMode_Replace
  
  kFxPathBlendMode_Replace
  
  Маска смешает замену существующего содержания.
- kFxPathBlendMode_Intersect
  
  kFxPathBlendMode_Intersect
  
  Маска смешает использование пересечения.
Соедините цвет отображения каналом
Указывает цвета, хост-приложение может используемый для отображения пути к пользователю.

Объявление

Objective C

enum { kFxPathColor_Red = 0, kFxPathColor_Green, kFxPathColor_Blue, kFxPathColor_Purple, kFxPathColor_Orange, kFxPathColor_Magenta, kFxPathColor_Yellow, kFxPathColor_Cyan }; typedef NSUInteger FxPathColor;

Константы
- kFxPathColor_Red
  
  kFxPathColor_Red
  
  Путь выведен на экран с помощью красного цвета.
- kFxPathColor_Green
  
  kFxPathColor_Green
  
  Путь выведен на экран с помощью цветного зеленого.
- kFxPathColor_Blue
  
  kFxPathColor_Blue
  
  Путь выведен на экран с помощью цветного синего.
- kFxPathColor_Purple
  
  kFxPathColor_Purple
  
  Путь выведен на экран с помощью пурпурного цвета.
- kFxPathColor_Orange
  
  kFxPathColor_Orange
  
  Путь выведен на экран с помощью оранжевого цвета.
- kFxPathColor_Magenta
  
  kFxPathColor_Magenta
  
  Путь выведен на экран с помощью цветного пурпурного.
- kFxPathColor_Yellow
  
  kFxPathColor_Yellow
  
  Путь выведен на экран с помощью желтого цвета.
- kFxPathColor_Cyan
  
  kFxPathColor_Cyan
  
  Путь выведен на экран с помощью цветного циана.
Стиль пути
Указывает стиль пути: линейный, bezier, или B-сплайн. Это используется styleOfPath:error: метод и Path Vertex Properties структура.

Объявление

Objective C

enum { kFxPathStyle_Linear = 0, kFxPathStyle_Bezier, kFxPathStyle_XSpline }; typedef NSUInteger FxPathStyle;

Константы
- kFxPathType_Linear
  
  kFxPathType_Linear
  
  Путь составлен из линейных сегментов.
- kFxPathType_Bezier
  
  kFxPathType_Bezier
  
  Путь составлен из bezier сегментов.
- kFxPathType_XSpline
  
  kFxPathType_XSpline
  
  Путь является путем B-сплайна.