AAX_IACFViewContainer Class Reference

#include <AAX_IACFViewContainer.h>

Inheritance diagram for AAX_IACFViewContainer:

Collaboration diagram for AAX_IACFViewContainer:

Description

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

Public Member Functions
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 *oModifiers)=0
	Queries the host for the current modifier keys. More...
View change requests
virtual AAX_Result	SetViewSize (AAX_Point &iSize)=0
	Request a change to the main view size. More...
Host event handlers
virtual AAX_Result	HandleParameterMouseDown (AAX_CParamID iParamID, uint32_t iModifiers)=0
	Alert the host to a mouse down event. More...
virtual AAX_Result	HandleParameterMouseDrag (AAX_CParamID iParamID, uint32_t iModifiers)=0
	Alert the host to a mouse drag event. More...
virtual AAX_Result	HandleParameterMouseUp (AAX_CParamID iParamID, uint32_t iModifiers)=0
	Alert the host to a mouse up event. More...
Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE	QueryInterface (const acfIID &iid, void **ppOut)=0
	Returns pointers to supported interfaces. More...
virtual acfUInt32 ACFMETHODCALLTYPE	AddRef (void)=0
	Increments reference count. More...
virtual acfUInt32 ACFMETHODCALLTYPE	Release (void)=0
	Decrements reference count. More...

Member Function Documentation

virtual int32_t AAX_IACFViewContainer::GetType ( )

pure virtual

Returns the raw view type as one of AAX_EViewContainer_Type.

virtual void* AAX_IACFViewContainer::GetPtr ( )

pure virtual

Returns a pointer to the raw view.

virtual AAX_Result AAX_IACFViewContainer::GetModifiers ( uint32_t *  oModifiers )

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.

virtual AAX_Result AAX_IACFViewContainer::SetViewSize ( AAX_Point &  iSize )

pure virtual

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]

iSize

The new size to which the plug-in view should be set

virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseDown ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

pure virtual

Alert the host to a mouse down event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseDrag ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

pure virtual

Alert the host to a mouse drag event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

virtual AAX_Result AAX_IACFViewContainer::HandleParameterMouseUp ( AAX_CParamID  iParamID, uint32_t  iModifiers  )

pure virtual

Alert the host to a mouse up event.

Parameters

[in]	iParamID	ID of the parameter whose control is being edited
[in]	iModifiers	A bitmask of AAX_EModifiers values

---

The documentation for this class was generated from the following file:

• AAX_IACFViewContainer.h