| 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_IParameter.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 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
19/*================================================================================================*/
20
21
22#ifndef AAX_IPARAMETER_H
23#define AAX_IPARAMETER_H
24
25#include "AAX.h" //for types
26
27//Forward Declarations
28 class AAX_CString;
29 class AAX_IAutomationDelegate;
30 class AAX_ITaperDelegateBase;
31 class AAX_IDisplayDelegateBase;
32 class AAX_IString;
33
41 class AAX_IParameterValue
42{
43 public:
48 virtual ~AAX_IParameterValue() { }
49
55 virtual AAX_IParameterValue* Clone() const = 0;
56
63 virtual AAX_CParamID Identifier() const = 0;
64
77 virtual bool GetValueAsBool(bool* value) const = 0;
78
87 virtual bool GetValueAsInt32(int32_t* value) const = 0;
88
97 virtual bool GetValueAsFloat(float* value) const = 0;
98
107 virtual bool GetValueAsDouble(double* value) const = 0;
108
117 virtual bool GetValueAsString(AAX_IString* value) const = 0;
119};
120
136 class AAX_IParameter
137{
138 public:
143 virtual ~AAX_IParameter() { }
144
151 virtual AAX_IParameterValue* CloneValue() const = 0;
152
163 virtual AAX_CParamID Identifier() const = 0;
164
174 virtual void SetName(const AAX_CString& name) = 0;
175
181 virtual const AAX_CString& Name() const = 0;
182
192 virtual void AddShortenedName(const AAX_CString& name) = 0;
193
199 virtual const AAX_CString& ShortenedName(int32_t iNumCharacters) const = 0;
200
204 virtual void ClearShortenedNames() = 0;
206
207
216 virtual bool Automatable() const = 0;
217
223 virtual void SetAutomationDelegate( AAX_IAutomationDelegate * iAutomationDelegate ) = 0;
224
232 virtual void Touch() = 0;
233
240 virtual void Release() = 0;
242
255 virtual void SetNormalizedValue(double newNormalizedValue) = 0;
256
260 virtual double GetNormalizedValue() const = 0;
261
265 virtual void SetNormalizedDefaultValue(double normalizedDefault) = 0;
266
270 virtual double GetNormalizedDefaultValue() const = 0;
271
275 virtual void SetToDefaultValue() = 0;
276
289 virtual void SetNumberOfSteps(uint32_t numSteps) = 0;
290
295 virtual uint32_t GetNumberOfSteps() const = 0;
296
301 virtual uint32_t GetStepValue() const = 0;
302
307 virtual double GetNormalizedValueFromStep(uint32_t iStep) const = 0;
308
313 virtual uint32_t GetStepValueFromNormalizedValue(double normalizedValue) const = 0;
314
319 virtual void SetStepValue(uint32_t iStep) = 0;
320
322
323
338 virtual bool GetValueString(AAX_CString* valueString) const = 0;
339
350 virtual bool GetValueString(int32_t iMaxNumChars, AAX_CString* valueString) const = 0;
351
362 virtual bool GetNormalizedValueFromBool(bool value, double *normalizedValue) const = 0;
363
374 virtual bool GetNormalizedValueFromInt32(int32_t value, double *normalizedValue) const = 0;
375
386 virtual bool GetNormalizedValueFromFloat(float value, double *normalizedValue) const = 0;
387
398 virtual bool GetNormalizedValueFromDouble(double value, double *normalizedValue) const = 0;
399
410 virtual bool GetNormalizedValueFromString(const AAX_CString& valueString, double *normalizedValue) const = 0;
411
423 virtual bool GetBoolFromNormalizedValue(double normalizedValue, bool* value) const = 0;
424
436 virtual bool GetInt32FromNormalizedValue(double normalizedValue, int32_t* value) const = 0;
437
449 virtual bool GetFloatFromNormalizedValue(double normalizedValue, float* value) const = 0;
450
462 virtual bool GetDoubleFromNormalizedValue(double normalizedValue, double* value) const = 0;
463
475 virtual bool GetStringFromNormalizedValue(double normalizedValue, AAX_CString& valueString) const = 0;
476
490 virtual bool GetStringFromNormalizedValue(double normalizedValue, int32_t iMaxNumChars, AAX_CString& valueString) const = 0;
491
500 virtual bool SetValueFromString(const AAX_CString& newValueString) = 0;
502
515 virtual bool GetValueAsBool(bool* value) const = 0;
516
525 virtual bool GetValueAsInt32(int32_t* value) const = 0;
526
535 virtual bool GetValueAsFloat(float* value) const = 0;
536
545 virtual bool GetValueAsDouble(double* value) const = 0;
546
555 virtual bool GetValueAsString(AAX_IString* value) const = 0;
556
565 virtual bool SetValueWithBool(bool value) = 0;
566
575 virtual bool SetValueWithInt32(int32_t value) = 0;
576
585 virtual bool SetValueWithFloat(float value) = 0;
586
595 virtual bool SetValueWithDouble(double value) = 0;
596
605 virtual bool SetValueWithString(const AAX_IString& value) = 0;
607
608
616 virtual void SetType( AAX_EParameterType iControlType ) = 0;
617
622 virtual AAX_EParameterType GetType() const = 0;
623
624
630 virtual void SetOrientation( AAX_EParameterOrientation iOrientation ) = 0;
631
635 virtual AAX_EParameterOrientation GetOrientation() const = 0;
636
645 virtual void SetTaperDelegate ( AAX_ITaperDelegateBase & inTaperDelegate, bool inPreserveValue ) = 0;
646
653 virtual void SetDisplayDelegate ( AAX_IDisplayDelegateBase & inDisplayDelegate ) = 0;
654
655 public:
670 virtual void UpdateNormalizedValue(double newNormalizedValue) = 0;
672
673};
674
675#endif //AAX_IPARAMETER_H
676
677
678
679
AAX_EParameterType
AAX_EParameterType
FIC stuff that I can't include without DAE library dependence.
Definition: AAX_Enums.h:852
AAX_EParameterOrientation
int32_t AAX_EParameterOrientation
Typedef for a bitfield of AAX_EParameterOrientationBits values.
Definition: AAX_Enums.h:885
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:349
AAX_CString
A generic AAX string class with similar functionality to std::string
Definition: AAX_CString.h:44
AAX_IAutomationDelegate
Interface allowing an AAX plug-in to interact with the host's event system.
Definition: AAX_IAutomationDelegate.h:44
AAX_IDisplayDelegateBase
Defines the display behavior for a parameter.
Definition: AAX_IDisplayDelegate.h:50
AAX_IParameterValue
An abstract interface representing a parameter value of arbitrary type.
Definition: AAX_IParameter.h:42
AAX_IParameterValue::~AAX_IParameterValue
virtual ~AAX_IParameterValue()
Virtual destructor.
Definition: AAX_IParameter.h:48
AAX_IParameterValue::Clone
virtual AAX_IParameterValue * Clone() const =0
Clones the parameter object.
AAX_IParameterValue::GetValueAsFloat
virtual bool GetValueAsFloat(float *value) const =0
Retrieves the parameter's value as a float.
AAX_IParameterValue::GetValueAsBool
virtual bool GetValueAsBool(bool *value) const =0
Retrieves the parameter's value as a bool.
AAX_IParameterValue::Identifier
virtual AAX_CParamID Identifier() const =0
Returns the parameter's unique identifier.
AAX_IParameterValue::GetValueAsInt32
virtual bool GetValueAsInt32(int32_t *value) const =0
Retrieves the parameter's value as an int32_t.
AAX_IParameterValue::GetValueAsDouble
virtual bool GetValueAsDouble(double *value) const =0
Retrieves the parameter's value as a double.
AAX_IParameterValue::GetValueAsString
virtual bool GetValueAsString(AAX_IString *value) const =0
Retrieves the parameter's value as a string.
AAX_IParameter
The base interface for all normalizable plug-in parameters.
Definition: AAX_IParameter.h:137
AAX_IParameter::GetStringFromNormalizedValue
virtual bool GetStringFromNormalizedValue(double normalizedValue, AAX_CString &valueString) const =0
Converts a normalized parameter value to a string representing the corresponding real value.
AAX_IParameter::GetValueString
virtual bool GetValueString(AAX_CString *valueString) const =0
Serializes the parameter value into a string.
AAX_IParameter::GetType
virtual AAX_EParameterType GetType() const =0
Returns the type of this parameter as an AAX_EParameterType.
AAX_IParameter::SetValueWithString
virtual bool SetValueWithString(const AAX_IString &value)=0
Sets the parameter's value as a string.
AAX_IParameter::GetNormalizedValueFromBool
virtual bool GetNormalizedValueFromBool(bool value, double *normalizedValue) const =0
Converts a bool to a normalized parameter value.
AAX_IParameter::SetDisplayDelegate
virtual void SetDisplayDelegate(AAX_IDisplayDelegateBase &inDisplayDelegate)=0
Sets the parameter's display delegate.
AAX_IParameter::GetInt32FromNormalizedValue
virtual bool GetInt32FromNormalizedValue(double normalizedValue, int32_t *value) const =0
Converts a normalized parameter value to an integer representing the corresponding real value.
AAX_IParameter::SetValueWithFloat
virtual bool SetValueWithFloat(float value)=0
Sets the parameter's value as a float.
AAX_IParameter::GetOrientation
virtual AAX_EParameterOrientation GetOrientation() const =0
Returns the orientation of this parameter.
AAX_IParameter::Automatable
virtual bool Automatable() const =0
Returns true if the parameter is automatable, false if it is not.
AAX_IParameter::Identifier
virtual AAX_CParamID Identifier() const =0
Returns the parameter's unique identifier.
AAX_IParameter::SetToDefaultValue
virtual void SetToDefaultValue()=0
Restores the state of this parameter to its default value.
AAX_IParameter::GetValueAsInt32
virtual bool GetValueAsInt32(int32_t *value) const =0
Retrieves the parameter's value as an int32_t.
AAX_IParameter::SetAutomationDelegate
virtual void SetAutomationDelegate(AAX_IAutomationDelegate *iAutomationDelegate)=0
Sets the automation delegate (if one is required)
AAX_IParameter::GetNormalizedValue
virtual double GetNormalizedValue() const =0
Returns the normalized representation of the parameter's current real value.
AAX_IParameter::Release
virtual void Release()=0
Signals the automation system that a control has been released.
AAX_IParameter::Name
virtual const AAX_CString & Name() const =0
Returns the parameter's display name.
AAX_IParameter::UpdateNormalizedValue
virtual void UpdateNormalizedValue(double newNormalizedValue)=0
Sets the parameter's state given a normalized value.
AAX_IParameter::SetNormalizedDefaultValue
virtual void SetNormalizedDefaultValue(double normalizedDefault)=0
Sets the parameter's default value using its normalized representation.
AAX_IParameter::SetName
virtual void SetName(const AAX_CString &name)=0
Sets the parameter's display name.
AAX_IParameter::GetValueString
virtual bool GetValueString(int32_t iMaxNumChars, AAX_CString *valueString) const =0
Serializes the parameter value into a string, size hint included.
AAX_IParameter::GetBoolFromNormalizedValue
virtual bool GetBoolFromNormalizedValue(double normalizedValue, bool *value) const =0
Converts a normalized parameter value to a bool representing the corresponding real value.
AAX_IParameter::GetStepValueFromNormalizedValue
virtual uint32_t GetStepValueFromNormalizedValue(double normalizedValue) const =0
Returns the step value for a normalized value of the parameter.
AAX_IParameter::AddShortenedName
virtual void AddShortenedName(const AAX_CString &name)=0
Sets the parameter's shortened display name.
AAX_IParameter::~AAX_IParameter
virtual ~AAX_IParameter()
Virtual destructor.
Definition: AAX_IParameter.h:143
AAX_IParameter::GetNormalizedDefaultValue
virtual double GetNormalizedDefaultValue() const =0
Returns the normalized representation of the parameter's real default value.
AAX_IParameter::Touch
virtual void Touch()=0
Signals the automation system that a control has been touched.
AAX_IParameter::GetNormalizedValueFromStep
virtual double GetNormalizedValueFromStep(uint32_t iStep) const =0
Returns the normalized value for a given step.
AAX_IParameter::GetValueAsFloat
virtual bool GetValueAsFloat(float *value) const =0
Retrieves the parameter's value as a float.
AAX_IParameter::SetTaperDelegate
virtual void SetTaperDelegate(AAX_ITaperDelegateBase &inTaperDelegate, bool inPreserveValue)=0
Sets the parameter's taper delegate.
AAX_IParameter::GetNormalizedValueFromDouble
virtual bool GetNormalizedValueFromDouble(double value, double *normalizedValue) const =0
Converts a double to a normalized parameter value.
AAX_IParameter::GetStringFromNormalizedValue
virtual bool GetStringFromNormalizedValue(double normalizedValue, int32_t iMaxNumChars, AAX_CString &valueString) const =0
Converts a normalized parameter value to a string representing the corresponding real,...
AAX_IParameter::SetValueWithDouble
virtual bool SetValueWithDouble(double value)=0
Sets the parameter's value as a double.
AAX_IParameter::GetValueAsBool
virtual bool GetValueAsBool(bool *value) const =0
Retrieves the parameter's value as a bool.
AAX_IParameter::SetStepValue
virtual void SetStepValue(uint32_t iStep)=0
Returns the current step for the current value of the parameter.
AAX_IParameter::SetValueWithInt32
virtual bool SetValueWithInt32(int32_t value)=0
Sets the parameter's value as an int32_t.
AAX_IParameter::GetNormalizedValueFromInt32
virtual bool GetNormalizedValueFromInt32(int32_t value, double *normalizedValue) const =0
Converts an integer to a normalized parameter value.
AAX_IParameter::GetValueAsString
virtual bool GetValueAsString(AAX_IString *value) const =0
Retrieves the parameter's value as a string.
AAX_IParameter::GetFloatFromNormalizedValue
virtual bool GetFloatFromNormalizedValue(double normalizedValue, float *value) const =0
Converts a normalized parameter value to a float representing the corresponding real value.
AAX_IParameter::ShortenedName
virtual const AAX_CString & ShortenedName(int32_t iNumCharacters) const =0
Returns the parameter's shortened display name.
AAX_IParameter::GetDoubleFromNormalizedValue
virtual bool GetDoubleFromNormalizedValue(double normalizedValue, double *value) const =0
Converts a normalized parameter value to a double representing the corresponding real value.
AAX_IParameter::SetType
virtual void SetType(AAX_EParameterType iControlType)=0
Sets the type of this parameter.
AAX_IParameter::SetNumberOfSteps
virtual void SetNumberOfSteps(uint32_t numSteps)=0
Sets the number of discrete steps for this parameter.
AAX_IParameter::SetOrientation
virtual void SetOrientation(AAX_EParameterOrientation iOrientation)=0
Sets the orientation of this parameter.
AAX_IParameter::CloneValue
virtual AAX_IParameterValue * CloneValue() const =0
Clone the parameter's value to a new AAX_IParameterValue object.
AAX_IParameter::SetNormalizedValue
virtual void SetNormalizedValue(double newNormalizedValue)=0
Sets a parameter value using it's normalized representation.
AAX_IParameter::GetStepValue
virtual uint32_t GetStepValue() const =0
Returns the current step for the current value of the parameter.
AAX_IParameter::GetValueAsDouble
virtual bool GetValueAsDouble(double *value) const =0
Retrieves the parameter's value as a double.
AAX_IParameter::GetNormalizedValueFromString
virtual bool GetNormalizedValueFromString(const AAX_CString &valueString, double *normalizedValue) const =0
Converts a given string to a normalized parameter value.
AAX_IParameter::SetValueFromString
virtual bool SetValueFromString(const AAX_CString &newValueString)=0
Converts a string to a real parameter value and sets the parameter to this value.
AAX_IParameter::ClearShortenedNames
virtual void ClearShortenedNames()=0
Clears the internal list of shortened display names.
AAX_IParameter::SetValueWithBool
virtual bool SetValueWithBool(bool value)=0
Sets the parameter's value as a bool.
AAX_IParameter::GetNumberOfSteps
virtual uint32_t GetNumberOfSteps() const =0
Returns the number of discrete steps used by the parameter.
AAX_IParameter::GetNormalizedValueFromFloat
virtual bool GetNormalizedValueFromFloat(float value, double *normalizedValue) const =0
Converts a float to a normalized parameter value.
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:38
AAX_ITaperDelegateBase
Defines the taper conversion behavior for a parameter.
Definition: AAX_ITaperDelegate.h:70