#include <AAX_IACFViewContainer.h>
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the host app and by effect components.
- See also
- AAX_IViewContainer
◆ GetType()
virtual int32_t AAX_IACFViewContainer::GetType |
( |
| ) |
|
|
pure virtual |
◆ GetPtr()
virtual void* AAX_IACFViewContainer::GetPtr |
( |
| ) |
|
|
pure virtual |
Returns a pointer to the raw view.
◆ GetModifiers()
virtual AAX_Result AAX_IACFViewContainer::GetModifiers |
( |
uint32_t * |
outModifiers | ) |
|
|
pure virtual |
Queries the host for the current modifier keys.
This method returns a bit mask with bits set for each of the currently active modifier keys. This method does not return the state of the AAX_eModifiers_SecondaryButton.
- Host Compatibility Notes:
- Although this method allows plug-ins to acquire the current state of the Windows key (normally blocked by Pro Tools), plug-ins should not use key combinations that require this key.
- Parameters
-
◆ SetViewSize()
Request a change to the main view size.
- Note
- For compatibility with the smallest supported displays, plug-in GUI dimensions should not exceed 749x617 pixels, or 749x565 pixels for plug-ins with sidechain support.
- Parameters
-
[in] | inSize | The new size to which the plug-in view should be set |
◆ HandleParameterMouseDown()
virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseDown |
( |
AAX_CParamID |
inParamID, |
|
|
uint32_t |
inModifiers |
|
) |
| |
|
pure virtual |
Alert the host to a mouse down event.
- Parameters
-
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
◆ HandleParameterMouseDrag()
virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseDrag |
( |
AAX_CParamID |
inParamID, |
|
|
uint32_t |
inModifiers |
|
) |
| |
|
pure virtual |
Alert the host to a mouse drag event.
- Warning
- The host may return AAX_ERROR_UNIMPLEMENTED for this event even if the host did handle the corresponding mouse down event. A plug-in should ignore any following mouse drag and mouse up events that correspond to a host-managed mouse down event. (PTSW-195209 / PT-218474)
- Parameters
-
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
◆ HandleParameterMouseUp()
virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseUp |
( |
AAX_CParamID |
inParamID, |
|
|
uint32_t |
inModifiers |
|
) |
| |
|
pure virtual |
Alert the host to a mouse up event.
- Warning
- The host may return AAX_ERROR_UNIMPLEMENTED for this event even if the host did handle the corresponding mouse down event. A plug-in should ignore any following mouse drag and mouse up events that correspond to a host-managed mouse down event. (PTSW-195209 / PT-218474)
- Parameters
-
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
The documentation for this class was generated from the following file: