PF_EventUnion¶
The PF_EventUnion in PF_EventExtra is a union of the four following structures.
Click¶
A mouse click or drag occurred within the custom UI’s area.
PF_DoClickEventInfo¶
Member |
Purpose |
---|---|
|
The (OS-level) time at which the click occurred. |
|
Where, in screen coordinates, the click occurred. For Custom Comp UI, these coordinates can be converted to composition coordinates using the UI Callbacks. See the CCU sample project for an example. |
|
The number of clicks that occurred. |
|
Which modifier keys (if any) were held down during click. |
|
An array of 4 |
|
Set this flag to |
|
Set when the drag event ends (the user has released the mouse button). |
Draw¶
After Effects needs your custom UI to refresh.
Note: when handling draw requests, use the image dimensions provided in PF_InData (rather that the dimensions of your input layer, as you would during PF_Cmd_RENDER).
PF_DrawEventInfo¶
Member |
Purpose |
---|---|
|
The rectangle in which to draw, in the context window’s coordinate system. These coordinates can be converted to different coordinate systems using the UI Callbacks. See the CCU sample project for an example. |
|
Pixel depth of the drawing context. |
Keydown¶
The user pressed a key, and the effect’s UI is active.
Use the macros in AE_EffectUI.h to access and manipulate the key codes received.
In order to receive keydown events in Premiere Pro, plug-ins must set PF_CustomEFlag_COMP in PF_CustomUIInfo.events during .. _PF_Cmd_PARAM_SETUP. PF_KeyDownEvent ****************************************************************************
Member |
Purpose |
---|---|
|
Time at which the click occurred. |
|
Screen coordinate of the mouse pointer when the key was pressed. For Custom Comp UI, these coordinates can be converted to composition coordinates using the UI Callbacks. See the CCU sample project for an example. |
|
Either a character code (for printable characters, we use the unshifted upper case version; A not a, 7 not &), or a control code:
…
|
|
Which (if any) modifier keys were down during the key press.
|
AdjustCursor¶
The cursor has moved onto (but not off of) the effect’s custom UI, to allow the effect to change the cursor.
PF_AdjustCursorEventInfo¶
Member |
Purpose |
---|---|
|
Screen coordinate of the mouse pointer. For Custom Comp UI, these coordinates can be converted to composition coordinates using the UI Callbacks. See the CCU sample project for an example. |
|
What, if any, modifier keys were held down when the message was sent. |
|
Set this to your desired cursor, or |
Arbitrary Parameters Event¶
After Effects needs your plug-in to manage it’s arbitrary data parameter(s).
Though arbitrary data types are not required for custom UI support, PF_ArbParamsExtra
follows the EventInfo model.
PF_ArbParamsExtra¶
Member |
Purpose |
---|---|
|
A |
|
Used by After Effects; will match the ID assigned to the arbitrary data type during PF_Cmd_PARAM_SETUP. |
|
Used for byte-alignment |
u {
new_func_params
dispose_func_params
copy_func_params
flat_size_func_params
flatten_func_params
unflatten_func_params
interp_func_params
compare_func_params
print_size_func_params
print_func_params
scan_func_params
}
|
(One of these will be passed; see Arbitrary Data Parameters) |