![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_IViewContainer.h>
Interface for the AAX host's view of a single instance of an effect. Used both by clients of the AAX host and by effect components.
Public Member Functions | |
virtual | ~AAX_IViewContainer (void) |
View and GUI state queries | |
virtual int32_t | GetType ()=0 |
Returns the raw view type as one of AAX_EViewContainer_Type. More... | |
virtual void * | GetPtr ()=0 |
Returns a pointer to the raw view. More... | |
virtual AAX_Result | GetModifiers (uint32_t *outModifiers)=0 |
Queries the host for the current modifier keys. More... | |
View change requests | |
virtual AAX_Result | SetViewSize (AAX_Point &inSize)=0 |
Request a change to the main view size. More... | |
Host event handlers | |
These methods are used to pass plug-in GUI events to the host for handling. Events should always be passed on in this way when there is a possibility of the host overriding the event with its own behavior. For example, in Pro Tools a command-control-option-click on any automatable plug-in parameter editor should bring up that parameter's automation pop-up menu, and a control-right click should display the parameter's automation lane in the Pro Tools Edit window. In order for Pro Tools to handle these events, the plug-in must pass them on using HandleParameterMouseDown() For each of these methods:
| |
virtual AAX_Result | HandleParameterMouseDown (AAX_CParamID inParamID, uint32_t inModifiers)=0 |
Alert the host to a mouse down event. More... | |
virtual AAX_Result | HandleParameterMouseDrag (AAX_CParamID inParamID, uint32_t inModifiers)=0 |
Alert the host to a mouse drag event. More... | |
virtual AAX_Result | HandleParameterMouseUp (AAX_CParamID inParamID, uint32_t inModifiers)=0 |
Alert the host to a mouse up event. More... | |
virtual AAX_Result | HandleMultipleParametersMouseDown (const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0 |
Alert the host to a mouse down event. More... | |
virtual AAX_Result | HandleMultipleParametersMouseDrag (const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0 |
Alert the host to a mouse drag event. More... | |
virtual AAX_Result | HandleMultipleParametersMouseUp (const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0 |
Alert the host to a mouse up event. More... | |
|
inlinevirtual |
|
pure virtual |
Returns the raw view type as one of AAX_EViewContainer_Type.
Implemented in AAX_VViewContainer.
|
pure virtual |
Returns a pointer to the raw view.
Implemented in AAX_VViewContainer.
|
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.
[out] | outModifiers | Current modifiers as a bitmask of AAX_EModifiers |
Implemented in AAX_VViewContainer.
|
pure virtual |
Request a change to the main view size.
[in] | inSize | The new size to which the plug-in view should be set |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse down event.
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse drag event.
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse up event.
[in] | inParamID | ID of the parameter whose control is being edited |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse down event.
[in] | inParamIDs | IDs of the parameters that belong to the same GUI element whose controls are being edited |
[in] | inNumOfParams | Number of parameter IDS |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse drag event.
[in] | inParamIDs | IDs of the parameters that belong to the same GUI element whose controls are being edited |
[in] | inNumOfParams | Number of parameter IDS |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.
|
pure virtual |
Alert the host to a mouse up event.
[in] | inParamIDs | IDs of the parameters that belong to the same GUI element whose controls are being edited |
[in] | inNumOfParams | Number of parameter IDS |
[in] | inModifiers | A bitmask of AAX_EModifiers values |
Implemented in AAX_VViewContainer.