| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IACFViewContainer.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 2021, 2023-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
33/*================================================================================================*/
34
35
36#ifndef _AAX_IACFVIEWCONTAINER_H_
37#define _AAX_IACFVIEWCONTAINER_H_
38
39#include "AAX_GUITypes.h"
40#include "AAX.h"
41
42#ifdef __clang__
43#pragma clang diagnostic push
44#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
45#endif
46
47#include "acfunknown.h"
48
55 class AAX_IACFViewContainer : public IACFUnknown
56{
57 public:
61 virtual int32_t GetType () = 0;
62 virtual void * GetPtr () = 0;
63 virtual AAX_Result GetModifiers ( uint32_t * outModifiers ) = 0;
65
69 virtual AAX_Result SetViewSize ( AAX_Point & inSize ) = 0;
71
75 virtual AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
76 virtual AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
77 virtual AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
79};
80
81
88 class AAX_IACFViewContainer_V2 : public AAX_IACFViewContainer
89{
90 public:
94 virtual AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
95 virtual AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
96 virtual AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
98};
99
100
106 class AAX_IACFViewContainer_V3 : public AAX_IACFViewContainer_V2
107{
108 public:
112 virtual AAX_Result HandleParameterMouseEnter(AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
113 virtual AAX_Result HandleParameterMouseExit(AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
115};
116
117
118#ifdef __clang__
119#pragma clang diagnostic pop
120#endif
121
122#endif
AAX_GUITypes.h
Constants and other definitions used by AAX plug-in GUIs.
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:52
AAX_IACFViewContainer
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the host...
Definition: AAX_IACFViewContainer.h:56
AAX_IACFViewContainer::GetModifiers
virtual AAX_Result GetModifiers(uint32_t *outModifiers)=0
Queries the host for the current modifier keys.
AAX_IACFViewContainer::SetViewSize
virtual AAX_Result SetViewSize(AAX_Point &inSize)=0
Request a change to the main view size.
AAX_IACFViewContainer::GetPtr
virtual void * GetPtr()=0
Returns a pointer to the raw view.
AAX_IACFViewContainer::HandleParameterMouseDrag
virtual AAX_Result HandleParameterMouseDrag(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
AAX_IACFViewContainer::GetType
virtual int32_t GetType()=0
Returns the raw view type as one of AAX_EViewContainer_Type.
AAX_IACFViewContainer::HandleParameterMouseUp
virtual AAX_Result HandleParameterMouseUp(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse up event.
AAX_IACFViewContainer::HandleParameterMouseDown
virtual AAX_Result HandleParameterMouseDown(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse down event.
AAX_IACFViewContainer_V2
Supplemental interface for the AAX host's view of a single instance of an effect. Used by both client...
Definition: AAX_IACFViewContainer.h:89
AAX_IACFViewContainer_V2::HandleMultipleParametersMouseDown
virtual AAX_Result HandleMultipleParametersMouseDown(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse down event.
AAX_IACFViewContainer_V2::HandleMultipleParametersMouseUp
virtual AAX_Result HandleMultipleParametersMouseUp(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse up event.
AAX_IACFViewContainer_V2::HandleMultipleParametersMouseDrag
virtual AAX_Result HandleMultipleParametersMouseDrag(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers)=0
Alert the host to a mouse drag event.
AAX_IACFViewContainer_V3
Additional methods to track mouse as it moves over controls.
Definition: AAX_IACFViewContainer.h:107
AAX_IACFViewContainer_V3::HandleParameterMouseEnter
virtual AAX_Result HandleParameterMouseEnter(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse enter event to the parameter's control.
AAX_IACFViewContainer_V3::HandleParameterMouseExit
virtual AAX_Result HandleParameterMouseExit(AAX_CParamID inParamID, uint32_t inModifiers)=0
Alert the host to a mouse exit event from the parameter's control.