| AAX SDK 2.6.1 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 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
20/*================================================================================================*/
21
22
23#ifndef _AAX_IACFVIEWCONTAINER_H_
24#define _AAX_IACFVIEWCONTAINER_H_
25
26#include "AAX_GUITypes.h"
27#include "AAX.h"
28
29#ifdef __clang__
30#pragma clang diagnostic push
31#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
32#endif
33
34#include "acfunknown.h"
35
42 class AAX_IACFViewContainer : public IACFUnknown
43{
44 public:
48 virtual int32_t GetType () = 0;
49 virtual void * GetPtr () = 0;
50 virtual AAX_Result GetModifiers ( uint32_t * outModifiers ) = 0;
52
56 virtual AAX_Result SetViewSize ( AAX_Point & inSize ) = 0;
58
62 virtual AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
63 virtual AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
64 virtual AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
66};
67
68
75 class AAX_IACFViewContainer_V2 : public AAX_IACFViewContainer
76{
77 public:
81 virtual AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
82 virtual AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
83 virtual AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) = 0;
85};
86
87
93 class AAX_IACFViewContainer_V3 : public AAX_IACFViewContainer_V2
94{
95 public:
99 virtual AAX_Result HandleParameterMouseEnter(AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
100 virtual AAX_Result HandleParameterMouseExit(AAX_CParamID inParamID, uint32_t inModifiers ) = 0;
102};
103
104
105#ifdef __clang__
106#pragma clang diagnostic pop
107#endif
108
109#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:349
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:39
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:43
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:76
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:94
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.