| 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_VViewContainer.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
32/*================================================================================================*/
33
34#ifndef AAX_VVIEWCONTAINER_H
35#define AAX_VVIEWCONTAINER_H
36
37#include "AAX_IViewContainer.h"
38#include "AAX_IACFViewContainer.h"
39#include "ACFPtr.h"
40
41
42 class IACFUnknown;
43
48 class AAX_VViewContainer : public AAX_IViewContainer
49{
50 public:
51 AAX_VViewContainer( IACFUnknown * pUnknown );
52 ~AAX_VViewContainer() AAX_OVERRIDE;
53
54 // AAX_IACFViewContainer
55
56 // Getters
57 int32_t GetType () AAX_OVERRIDE;
58 void * GetPtr () AAX_OVERRIDE;
59 AAX_Result GetModifiers ( uint32_t * outModifiers ) AAX_OVERRIDE;
60
61 // Setters
62 AAX_Result SetViewSize ( AAX_Point & inSize ) AAX_OVERRIDE;
63 AAX_Result HandleParameterMouseDown ( AAX_CParamID inParamID, uint32_t inModifiers ) AAX_OVERRIDE;
64 AAX_Result HandleParameterMouseDrag ( AAX_CParamID inParamID, uint32_t inModifiers ) AAX_OVERRIDE;
65 AAX_Result HandleParameterMouseUp ( AAX_CParamID inParamID, uint32_t inModifiers ) AAX_OVERRIDE;
66 AAX_Result HandleParameterMouseEnter ( AAX_CParamID inParamID, uint32_t inModifiers ) AAX_OVERRIDE;
67 AAX_Result HandleParameterMouseExit ( AAX_CParamID inParamID, uint32_t inModifiers ) AAX_OVERRIDE;
68 AAX_Result HandleMultipleParametersMouseDown ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) AAX_OVERRIDE;
69 AAX_Result HandleMultipleParametersMouseDrag ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) AAX_OVERRIDE;
70 AAX_Result HandleMultipleParametersMouseUp ( const AAX_CParamID* inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers ) AAX_OVERRIDE;
71
72private:
73 ACFPtr<AAX_IACFViewContainer> mIViewContainer;
74 ACFPtr<AAX_IACFViewContainer_V2> mIViewContainerV2;
75 ACFPtr<AAX_IACFViewContainer_V3> mIViewContainerV3;
76};
77
78
79#endif //AAX_VVIEWCONTAINER_H
AAX_IACFViewContainer.h
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAXH...
AAX_IViewContainer.h
Interface for the AAX host's view of a single instance of an effect.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
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_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_V3
Additional methods to track mouse as it moves over controls.
Definition: AAX_IACFViewContainer.h:107
AAX_IViewContainer
Interface for the AAX host's view of a single instance of an effect. Used both by clients of the AAX ...
Definition: AAX_IViewContainer.h:51
AAX_VViewContainer
Version-managed concrete AAX_IViewContainer class.
Definition: AAX_VViewContainer.h:49
AAX_VViewContainer::GetPtr
void * GetPtr() AAX_OVERRIDE
Returns a pointer to the raw view.
AAX_VViewContainer::GetType
int32_t GetType() AAX_OVERRIDE
Returns the raw view type as one of AAX_EViewContainer_Type.
AAX_VViewContainer::HandleMultipleParametersMouseDrag
AAX_Result HandleMultipleParametersMouseDrag(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse drag event.
AAX_VViewContainer::HandleParameterMouseEnter
AAX_Result HandleParameterMouseEnter(AAX_CParamID inParamID, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse enter event to the parameter's control.
AAX_VViewContainer::~AAX_VViewContainer
~AAX_VViewContainer() AAX_OVERRIDE
AAX_VViewContainer::SetViewSize
AAX_Result SetViewSize(AAX_Point &inSize) AAX_OVERRIDE
Request a change to the main view size.
AAX_VViewContainer::HandleMultipleParametersMouseUp
AAX_Result HandleMultipleParametersMouseUp(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse up event.
AAX_VViewContainer::HandleParameterMouseDown
AAX_Result HandleParameterMouseDown(AAX_CParamID inParamID, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse down event.
AAX_VViewContainer::HandleParameterMouseExit
AAX_Result HandleParameterMouseExit(AAX_CParamID inParamID, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse exit event from the parameter's control.
AAX_VViewContainer::AAX_VViewContainer
AAX_VViewContainer(IACFUnknown *pUnknown)
AAX_VViewContainer::GetModifiers
AAX_Result GetModifiers(uint32_t *outModifiers) AAX_OVERRIDE
Queries the host for the current modifier keys.
AAX_VViewContainer::HandleMultipleParametersMouseDown
AAX_Result HandleMultipleParametersMouseDown(const AAX_CParamID *inParamIDs, uint32_t inNumOfParams, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse down event.
AAX_VViewContainer::HandleParameterMouseDrag
AAX_Result HandleParameterMouseDrag(AAX_CParamID inParamID, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse drag event.
AAX_VViewContainer::HandleParameterMouseUp
AAX_Result HandleParameterMouseUp(AAX_CParamID inParamID, uint32_t inModifiers) AAX_OVERRIDE
Alert the host to a mouse up event.