FxPathAPI_v3

Declaration

protocol FxPathAPI_v3

Overview

This API is used to get information about a path that the user has drawn on an object in the canvas. You can get the number of paths applied to the object, and then enumerate through them, or pick a specific one. You can use this API to retrieve the control points along the path and use that information to guide the rendering of your plug-in.

Topics

Getting Path Information

• numberOfPaths(at:)
• pathID(_:for:)
• name(_:ofPath:)
• isPath(_:open:at:)
• isPath(_:inverted:at:)
• style(_:ofPath:)
• length(_:ofPath:at:)
• length(_:ofSegment:ofPath:at:)
• number(ofVertices:inPath:at:)
• vertex(_:at:ofPath:at:)
• point(_:atPercentageOfDistance:alongPath:at:)
• point(_:atPercentageOfParameter:alongPath:at:)
• blendMode(_:ofPath:)
• pathGeometryInfo(_:forPath:at:)

Setting Path Information

• setPath(_:toColor:)

Structuring Path Information

• FxPathGeometryInfo
• FxVertex

Constants

• FxPathBlendMode
• FxPathColor
• FxPathID
• FxPathStyle

See Also

User interface

• Adding parameters to plug-ins
• Adding onscreen controls to plug-ins
• FxUndoAPI
• FxCommandAPI
• FxCommandAPI_v2
• FxRemoteWindowAPI
• FxRemoteWindowAPI_v2