25 #ifndef AAX_CPARAMETER_H
26 #define AAX_CPARAMETER_H
95 const T&
Get()
const {
return mValue; }
98 void Set(
const T& inValue) { mValue = inValue; }
117 void InitIdentifier(
const char* inIdentifier);
127 template <
typename T>
131 InitIdentifier(identifier);
134 template <
typename T>
138 InitIdentifier(identifier);
141 template <
typename T>
143 : mValue(other.mValue)
145 InitIdentifier(other.mIdentifier);
193 const size_t len = strlen(inIdentifier);
194 AAX_ASSERT(len < eParemeterDefaultMaxIdentifierSize);
195 if (len < eParemeterDefaultMaxIdentifierSize)
197 std::strncpy(mIdentifier, inIdentifier, 1+len);
198 mIdentifier[len] = 0;
202 std::strncpy(mIdentifier, inIdentifier, eParameterDefaultMaxIdentifierLength);
203 mIdentifier[eParameterDefaultMaxIdentifierLength] = 0;
236 template <
typename T>
490 void InitializeNumberOfSteps();
496 template <typename T>
510 this->InitializeNumberOfSteps();
514 template <
typename T>
525 ,
mValue(identifier.Get())
528 this->InitializeNumberOfSteps();
532 template <
typename T>
535 , mAutomatable(automatable)
539 , mTaperDelegate(NULL)
540 , mDisplayDelegate(NULL)
541 , mAutomationDelegate(NULL)
544 , mDefaultValue(defaultValue)
546 this->InitializeNumberOfSteps();
550 template <
typename T>
553 , mAutomatable(automatable)
557 , mTaperDelegate(NULL)
558 , mDisplayDelegate(NULL)
559 , mAutomationDelegate(NULL)
564 this->InitializeNumberOfSteps();
568 template <
typename T>
572 SetAutomationDelegate(0);
574 delete mTaperDelegate;
576 delete mDisplayDelegate;
577 mDisplayDelegate = 0;
580 template <
typename T>
586 template <
typename T>
589 return mValue.Identifier();
592 template <
typename T>
595 mNames.SetPrimary(name);
598 template <
typename T>
601 return mNames.Primary();
604 template <
typename T>
610 template <
typename T>
613 return mNames.
Get(iNumCharacters);
616 template <
typename T>
627 double newNormalizedValue = mTaperDelegate->RealToNormalized(newValue);
633 if ( mAutomationDelegate )
641 mAutomationDelegate->PostSetValueRequest(Identifier(), newNormalizedValue );
652 UpdateNormalizedValue(newNormalizedValue);
656 template <
typename T>
659 T newValue = mTaperDelegate->NormalizedToReal(newNormalizedValue);
660 if (mNeedNotify || (mValue.Get() != newValue))
663 mValue.Set(newValue);
667 if (mAutomationDelegate)
668 mAutomationDelegate->PostCurrentValue(Identifier(), newNormalizedValue);
675 template <
typename T>
680 switch (mControlType)
686 this->SetNumberOfSteps (eParameterDefaultNumStepsDiscrete);
694 this->SetNumberOfSteps (eParameterDefaultNumStepsContinuous);
716 return mValue.GetValueAsBool(value);
722 return mValue.GetValueAsInt32(value);
728 return mValue.GetValueAsFloat(value);
734 return mValue.GetValueAsDouble(value);
744 result = this->GetValueString(&valueString);
747 *value = valueString;
793 return this->SetValueFromString(valueString);
801 T newDefaultValue = mTaperDelegate->NormalizedToReal(newNormalizedDefault);
802 SetDefaultValue(newDefaultValue);
808 double normalizedDefault = mTaperDelegate->RealToNormalized(mDefaultValue);
809 return normalizedDefault;
815 newDefaultValue = mTaperDelegate->ConstrainRealValue(newDefaultValue);
816 mDefaultValue = newDefaultValue;
822 return mDefaultValue;
828 SetValue(mDefaultValue);
837 mNumSteps = numSteps;
850 return GetStepValueFromNormalizedValue(this->GetNormalizedValue());
856 double numSteps = (double) this->GetNumberOfSteps ();
857 if ( numSteps < 2.0 )
860 double valuePerStep = 1.0 / ( numSteps - 1.0 );
861 double value = valuePerStep * (double) iStep;
864 else if ( value > 1.0 )
873 double numSteps = (double) this->GetNumberOfSteps ();
874 if ( numSteps < 2.0 )
877 double valuePerStep = 1.0 / ( numSteps - 1.0 );
878 double curStep = ( normalizedValue / valuePerStep ) + 0.5;
881 else if ( curStep > (
double) ( numSteps - 1.0 ) )
882 curStep = (double) ( numSteps - 1.0 );
884 return (uint32_t) curStep;
890 double numSteps = (double) this->GetNumberOfSteps ();
891 if ( numSteps < 2.0 )
894 this->SetNormalizedValue ( GetNormalizedValueFromStep(iStep) );
900 mControlType = iControlType;
912 mOrientation = iOrientation;
924 T newValue = mTaperDelegate->NormalizedToReal(normalizedNewValue);
925 this->SetValue(newValue);
932 return mTaperDelegate->RealToNormalized(val);
939 return mDisplayDelegate->ValueToString(this->GetValue(), valueString);
945 return mDisplayDelegate->ValueToString(this->GetValue(), valueString);
948 template <
typename T>
956 template <
typename T>
964 template <
typename T>
972 template <
typename T>
980 template <
typename T>
985 if (!mDisplayDelegate->StringToValue(valueString, &value))
990 *normalizedValue = mTaperDelegate->RealToNormalized(value);
1003 template<
typename T>
1011 template<
typename T>
1019 template<
typename T>
1027 template <
typename T>
1030 T value = mTaperDelegate->NormalizedToReal(normalizedValue);
1031 if (!mDisplayDelegate->ValueToString(value, &valueString))
1035 if ((value > mTaperDelegate->GetMaximumValue()) || (value < mTaperDelegate->GetMinimumValue()))
1040 template <
typename T>
1043 T value = mTaperDelegate->NormalizedToReal(normalizedValue);
1044 if (!mDisplayDelegate->ValueToString(value, iMaxNumChars, &valueString))
1048 if ((value > mTaperDelegate->GetMaximumValue()) || (value < mTaperDelegate->GetMinimumValue()))
1053 template<
typename T>
1057 if (!mDisplayDelegate->StringToValue(newValueString, &newValue))
1063 template<
typename T>
1066 double normalizeValue = this->GetNormalizedValue ();
1073 if ( inPreserveValue )
1074 this->SetValue ( mValue.Get() );
1075 else this->UpdateNormalizedValue ( normalizeValue );
1078 template<
typename T>
1085 if (mAutomationDelegate != 0)
1086 mAutomationDelegate->PostCurrentValue(this->Identifier(), this->GetNormalizedValue());
1089 template<
typename T>
1092 return mTaperDelegate;
1095 template<
typename T>
1098 return mDisplayDelegate;
1101 template<
typename T>
1104 return mAutomatable;
1107 template<
typename T>
1111 if ( mAutomationDelegate )
1113 mAutomationDelegate->UnregisterParameter ( this->Identifier() );
1117 mAutomationDelegate = iAutomationDelegate;
1118 if ( mAutomationDelegate )
1122 template<
typename T>
1126 if (mAutomationDelegate)
1127 mAutomationDelegate->PostTouchRequest( this->Identifier() );
1130 template<
typename T>
1134 if (mAutomationDelegate)
1135 mAutomationDelegate->PostReleaseRequest( this->Identifier() );
1142 #pragma mark AAX_CStatelessParameter
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:352
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:141
Declarations for cross-platform AAX_ASSERT, AAX_TRACE and related facilities.
#define AAX_ASSERT(condition)
Asserts that a condition is true and logs an error if the condition is false.
Definition: AAX_Assert.h:268
A generic AAX string class with similar functionality to std::string.
AAX_EParameterType
FIC stuff that I can't include without DAE library dependence.
Definition: AAX_Enums.h:833
@ AAX_eParameterType_Discrete
Definition: AAX_Enums.h:834
@ AAX_eParameterType_Continuous
Definition: AAX_Enums.h:835
int32_t AAX_EParameterOrientation
Typedef for a bitfield of AAX_EParameterOrientationBits values.
Definition: AAX_Enums.h:866
@ AAX_eParameterOrientation_Default
Definition: AAX_Enums.h:845
Interface allowing an AAX plug-in to interact with the host's automation system.
Defines the display behavior for a parameter.
The base interface for all normalizable plug-in parameters.
Defines the taper conversion behavior for a parameter.
Concrete implementation of AAX_IParameterValue.
Definition: AAX_CParameter.h:55
AAX_DEFAULT_MOVE_OPER(AAX_CParameterValue)
bool GetValueAsInt32(int32_t *value) const AAX_OVERRIDE
Retrieves the parameter's value as an int32_t.
Definition: AAX_CParameter.h:158
bool GetValueAsDouble(double *value) const AAX_OVERRIDE
Retrieves the parameter's value as a double.
Definition: AAX_CParameter.h:174
bool GetValueAsString(AAX_IString *value) const AAX_OVERRIDE
Retrieves the parameter's value as a string.
Definition: AAX_CParameter.h:182
Defaults
Definition: AAX_CParameter.h:57
@ eParameterDefaultMaxIdentifierLength
Definition: AAX_CParameter.h:59
@ eParemeterDefaultMaxIdentifierSize
Definition: AAX_CParameter.h:58
AAX_IParameterValue * Clone() const AAX_OVERRIDE
Clones the parameter object.
Definition: AAX_CParameter.h:102
void Set(const T &inValue)
Direct access to the template instance's value.
Definition: AAX_CParameter.h:98
bool GetValueAsBool(bool *value) const AAX_OVERRIDE
Retrieves the parameter's value as a bool.
Definition: AAX_CParameter.h:149
AAX_DEFAULT_DTOR_OVERRIDE(AAX_CParameterValue)
const T & Get() const
Direct access to the template instance's value.
Definition: AAX_CParameter.h:95
bool GetValueAsFloat(float *value) const AAX_OVERRIDE
Retrieves the parameter's value as a float.
Definition: AAX_CParameter.h:166
AAX_CParameterValue(AAX_CParamID identifier)
Constructs an AAX_CParameterValue object.
Definition: AAX_CParameter.h:128
AAX_DELETE(AAX_CParameterValue &operator=(const AAX_CParameterValue &))
AAX_CParamID Identifier() const AAX_OVERRIDE
Returns the parameter's unique identifier.
Definition: AAX_CParameter.h:103
AAX_DEFAULT_MOVE_CTOR(AAX_CParameterValue)
Generic implementation of an AAX_IParameter.
Definition: AAX_CParameter.h:238
bool SetValueWithString(const AAX_IString &value) AAX_OVERRIDE
Sets the parameter's value as a string.
Definition: AAX_CParameter.h:790
AAX_CParameterValue< T > mValue
Definition: AAX_CParameter.h:486
Type
Definition: AAX_CParameter.h:241
@ eParameterTypeUndefined
Definition: AAX_CParameter.h:242
@ eParameterTypeInt32
Definition: AAX_CParameter.h:244
@ eParameterTypeCustom
Definition: AAX_CParameter.h:246
@ eParameterTypeFloat
Definition: AAX_CParameter.h:245
@ eParameterTypeBool
Definition: AAX_CParameter.h:243
bool GetBoolFromNormalizedValue(double normalizedValue, bool *value) const AAX_OVERRIDE
Converts a normalized parameter value to a bool representing the corresponding real value.
Definition: AAX_CParameter.h:995
AAX_EParameterType GetType() const AAX_OVERRIDE
Returns the type of this parameter as an AAX_EParameterType.
Definition: AAX_CParameter.h:904
const AAX_CString & Name() const AAX_OVERRIDE
Returns the parameter's display name.
Definition: AAX_CParameter.h:599
AAX_EParameterOrientation mOrientation
Definition: AAX_CParameter.h:480
AAX_EParameterType mControlType
Definition: AAX_CParameter.h:479
AAX_CStringAbbreviations mNames
Definition: AAX_CParameter.h:476
AAX_DELETE(AAX_CParameter())
T mDefaultValue
Definition: AAX_CParameter.h:487
bool SetValueWithBool(bool value) AAX_OVERRIDE
Sets the parameter's value as a bool.
Definition: AAX_CParameter.h:758
AAX_IAutomationDelegate * mAutomationDelegate
Definition: AAX_CParameter.h:483
AAX_CParameter(AAX_CParamID identifier, const AAX_IString &name, T defaultValue, const AAX_ITaperDelegate< T > &taperDelegate, const AAX_IDisplayDelegate< T > &displayDelegate, bool automatable=false)
Constructs an AAX_CParameter object using the specified taper and display delegates.
Definition: AAX_CParameter.h:497
const AAX_CString & ShortenedName(int32_t iNumCharacters) const AAX_OVERRIDE
Returns the parameter's shortened display name.
Definition: AAX_CParameter.h:611
bool mNeedNotify
Definition: AAX_CParameter.h:484
double GetNormalizedValue() const AAX_OVERRIDE
Returns the normalized representation of the parameter's current real value.
Definition: AAX_CParameter.h:929
T GetDefaultValue() const
Returns the parameter's default value.
Definition: AAX_CParameter.h:820
bool GetNormalizedValueFromFloat(float value, double *normalizedValue) const AAX_OVERRIDE
Converts a float to a normalized parameter value.
Definition: AAX_CParameter.h:965
uint32_t mNumSteps
Definition: AAX_CParameter.h:478
bool GetValueAsFloat(float *value) const AAX_OVERRIDE
Retrieves the parameter's value as a float.
Definition: AAX_CParameter.h:726
void SetValue(T newValue)
Initiates a host request to set the parameter's value.
Definition: AAX_CParameter.h:625
~AAX_CParameter() AAX_OVERRIDE
Virtual destructor used to delete all locally allocated pointers.
Definition: AAX_CParameter.h:569
void Release() AAX_OVERRIDE
Signals the automation system that a control has been released.
Definition: AAX_CParameter.h:1131
AAX_DEFAULT_MOVE_CTOR(AAX_CParameter)
bool GetNormalizedValueFromBool(bool value, double *normalizedValue) const AAX_OVERRIDE
Converts a bool to a normalized parameter value.
Definition: AAX_CParameter.h:949
const AAX_IDisplayDelegate< T > * DisplayDelegate() const
Returns a reference to the parameter's display delegate.
Definition: AAX_CParameter.h:1096
Defaults
Definition: AAX_CParameter.h:249
@ eParameterDefaultNumStepsDiscrete
Definition: AAX_CParameter.h:250
@ eParameterDefaultNumStepsContinuous
Definition: AAX_CParameter.h:251
bool GetNormalizedValueFromInt32(int32_t value, double *normalizedValue) const AAX_OVERRIDE
Converts an integer to a normalized parameter value.
Definition: AAX_CParameter.h:957
bool GetValueAsBool(bool *value) const AAX_OVERRIDE
Retrieves the parameter's value as a bool.
Definition: AAX_CParameter.h:714
void SetTaperDelegate(AAX_ITaperDelegateBase &inTaperDelegate, bool inPreserveValue=true) AAX_OVERRIDE
Sets the parameter's taper delegate.
Definition: AAX_CParameter.h:1064
bool SetValueWithDouble(double value) AAX_OVERRIDE
Sets the parameter's value as a double.
Definition: AAX_CParameter.h:782
void SetDisplayDelegate(AAX_IDisplayDelegateBase &inDisplayDelegate) AAX_OVERRIDE
Sets the parameter's display delegate.
Definition: AAX_CParameter.h:1079
AAX_IParameterValue * CloneValue() const AAX_OVERRIDE
Clone the parameter's value to a new AAX_IParameterValue object.
Definition: AAX_CParameter.h:581
bool GetValueAsString(AAX_IString *value) const AAX_OVERRIDE
Retrieves the parameter's value as a string.
Definition: AAX_CParameter.h:738
bool GetNormalizedValueFromDouble(double value, double *normalizedValue) const AAX_OVERRIDE
Converts a double to a normalized parameter value.
Definition: AAX_CParameter.h:973
void SetStepValue(uint32_t iStep) AAX_OVERRIDE
Returns the current step for the current value of the parameter.
Definition: AAX_CParameter.h:888
T GetValue() const
Returns the parameter's value.
Definition: AAX_CParameter.h:707
AAX_EParameterOrientation GetOrientation() const AAX_OVERRIDE
Returns the orientation of this parameter.
Definition: AAX_CParameter.h:916
void UpdateNormalizedValue(double newNormalizedValue) AAX_OVERRIDE
Sets the parameter's state given a normalized value.
Definition: AAX_CParameter.h:657
AAX_DEFAULT_MOVE_OPER(AAX_CParameter)
void SetName(const AAX_CString &name) AAX_OVERRIDE
Sets the parameter's display name.
Definition: AAX_CParameter.h:593
uint32_t GetStepValue() const AAX_OVERRIDE
Returns the current step for the current value of the parameter.
Definition: AAX_CParameter.h:848
double GetNormalizedDefaultValue() const AAX_OVERRIDE
Returns the normalized representation of the parameter's real default value.
Definition: AAX_CParameter.h:806
void SetOrientation(AAX_EParameterOrientation iOrientation) AAX_OVERRIDE
Sets the orientation of this parameter.
Definition: AAX_CParameter.h:910
void SetToDefaultValue() AAX_OVERRIDE
Restores the state of this parameter to its default value.
Definition: AAX_CParameter.h:826
AAX_DELETE(AAX_CParameter(const AAX_CParameter &other))
void SetType(AAX_EParameterType iControlType) AAX_OVERRIDE
Sets the type of this parameter.
Definition: AAX_CParameter.h:898
void SetNormalizedDefaultValue(double normalizedDefault) AAX_OVERRIDE
Sets the parameter's default value using its normalized representation.
Definition: AAX_CParameter.h:799
const AAX_ITaperDelegate< T > * TaperDelegate() const
Returns a reference to the parameter's taper delegate.
Definition: AAX_CParameter.h:1090
double GetNormalizedValueFromStep(uint32_t iStep) const AAX_OVERRIDE
Returns the normalized value for a given step.
Definition: AAX_CParameter.h:854
void AddShortenedName(const AAX_CString &name) AAX_OVERRIDE
Sets the parameter's shortened display name.
Definition: AAX_CParameter.h:605
bool SetValueFromString(const AAX_CString &newValueString) AAX_OVERRIDE
Converts a string to a real parameter value and sets the parameter to this value.
Definition: AAX_CParameter.h:1054
bool GetInt32FromNormalizedValue(double normalizedValue, int32_t *value) const AAX_OVERRIDE
Converts a normalized parameter value to an integer representing the corresponding real value.
Definition: AAX_CParameter.h:1004
bool GetDoubleFromNormalizedValue(double normalizedValue, double *value) const AAX_OVERRIDE
Converts a normalized parameter value to a double representing the corresponding real value.
Definition: AAX_CParameter.h:1020
bool SetValueWithInt32(int32_t value) AAX_OVERRIDE
Sets the parameter's value as an int32_t.
Definition: AAX_CParameter.h:766
void ClearShortenedNames() AAX_OVERRIDE
Clears the internal list of shortened display names.
Definition: AAX_CParameter.h:617
AAX_ITaperDelegate< T > * mTaperDelegate
Definition: AAX_CParameter.h:481
bool SetValueWithFloat(float value) AAX_OVERRIDE
Sets the parameter's value as a float.
Definition: AAX_CParameter.h:774
uint32_t GetStepValueFromNormalizedValue(double normalizedValue) const AAX_OVERRIDE
Returns the step value for a normalized value of the parameter.
Definition: AAX_CParameter.h:871
void SetNumberOfSteps(uint32_t numSteps) AAX_OVERRIDE
Sets the number of discrete steps for this parameter.
Definition: AAX_CParameter.h:832
void SetNormalizedValue(double newNormalizedValue) AAX_OVERRIDE
Sets a parameter value using it's normalized representation.
Definition: AAX_CParameter.h:922
void SetAutomationDelegate(AAX_IAutomationDelegate *iAutomationDelegate) AAX_OVERRIDE
Sets the automation delegate (if one is required)
Definition: AAX_CParameter.h:1108
AAX_DELETE(AAX_CParameter &operator=(const AAX_CParameter &other))
bool GetValueString(AAX_CString *valueString) const AAX_OVERRIDE
Serializes the parameter value into a string.
Definition: AAX_CParameter.h:937
bool GetStringFromNormalizedValue(double normalizedValue, AAX_CString &valueString) const AAX_OVERRIDE
Converts a normalized parameter value to a string representing the corresponding real value.
Definition: AAX_CParameter.h:1028
bool GetFloatFromNormalizedValue(double normalizedValue, float *value) const AAX_OVERRIDE
Converts a normalized parameter value to a float representing the corresponding real value.
Definition: AAX_CParameter.h:1012
bool GetValueAsDouble(double *value) const AAX_OVERRIDE
Retrieves the parameter's value as a double.
Definition: AAX_CParameter.h:732
bool Automatable() const AAX_OVERRIDE
Returns true if the parameter is automatable, false if it is not.
Definition: AAX_CParameter.h:1102
AAX_CParamID Identifier() const AAX_OVERRIDE
Returns the parameter's unique identifier.
Definition: AAX_CParameter.h:587
bool GetNormalizedValueFromString(const AAX_CString &valueString, double *normalizedValue) const AAX_OVERRIDE
Converts a given string to a normalized parameter value.
Definition: AAX_CParameter.h:981
AAX_IDisplayDelegate< T > * mDisplayDelegate
Definition: AAX_CParameter.h:482
void SetDefaultValue(T newDefaultValue)
Set the parameter's default value.
Definition: AAX_CParameter.h:813
bool mAutomatable
Definition: AAX_CParameter.h:477
bool GetValueAsInt32(int32_t *value) const AAX_OVERRIDE
Retrieves the parameter's value as an int32_t.
Definition: AAX_CParameter.h:720
void Touch() AAX_OVERRIDE
Signals the automation system that a control has been touched.
Definition: AAX_CParameter.h:1123
uint32_t GetNumberOfSteps() const AAX_OVERRIDE
Returns the number of discrete steps used by the parameter.
Definition: AAX_CParameter.h:842
A stateless parameter implementation.
Definition: AAX_CParameter.h:1153
bool SetValueWithDouble(double) AAX_OVERRIDE
Sets the parameter's value as a double.
Definition: AAX_CParameter.h:1260
uint32_t GetStepValueFromNormalizedValue(double) const AAX_OVERRIDE
Returns the step value for a normalized value of the parameter.
Definition: AAX_CParameter.h:1222
const AAX_CString & Name() const AAX_OVERRIDE
Returns the parameter's display name.
Definition: AAX_CParameter.h:1181
bool GetValueAsInt32(int32_t *) const AAX_OVERRIDE
Retrieves the parameter's value as an int32_t.
Definition: AAX_CParameter.h:1253
void ClearShortenedNames() AAX_OVERRIDE
Clears the internal list of shortened display names.
Definition: AAX_CParameter.h:1184
double GetNormalizedDefaultValue() const AAX_OVERRIDE
Returns the normalized representation of the parameter's real default value.
Definition: AAX_CParameter.h:1216
bool GetStringFromNormalizedValue(double, AAX_CString &valueString) const AAX_OVERRIDE
Converts a normalized parameter value to a string representing the corresponding real value.
Definition: AAX_CParameter.h:1243
double GetNormalizedValue() const AAX_OVERRIDE
Returns the normalized representation of the parameter's current real value.
Definition: AAX_CParameter.h:1214
double GetNormalizedValueFromStep(uint32_t) const AAX_OVERRIDE
Returns the normalized value for a given step.
Definition: AAX_CParameter.h:1221
void SetTaperDelegate(AAX_ITaperDelegateBase &, bool) AAX_OVERRIDE
Sets the parameter's taper delegate.
Definition: AAX_CParameter.h:1270
const AAX_CString & ShortenedName(int32_t iNumCharacters) const AAX_OVERRIDE
Returns the parameter's shortened display name.
Definition: AAX_CParameter.h:1183
bool GetBoolFromNormalizedValue(double, bool *value) const AAX_OVERRIDE
Converts a normalized parameter value to a bool representing the corresponding real value.
Definition: AAX_CParameter.h:1239
AAX_IParameterValue * CloneValue() const AAX_OVERRIDE
Clone the parameter's value to a new AAX_IParameterValue object.
Definition: AAX_CParameter.h:1173
void AddShortenedName(const AAX_CString &name) AAX_OVERRIDE
Sets the parameter's shortened display name.
Definition: AAX_CParameter.h:1182
bool GetValueString(int32_t, AAX_CString *valueString) const AAX_OVERRIDE
Serializes the parameter value into a string, size hint included.
Definition: AAX_CParameter.h:1233
uint32_t GetStepValue() const AAX_OVERRIDE
Returns the current step for the current value of the parameter.
Definition: AAX_CParameter.h:1220
bool GetInt32FromNormalizedValue(double, int32_t *) const AAX_OVERRIDE
Converts a normalized parameter value to an integer representing the corresponding real value.
Definition: AAX_CParameter.h:1240
AAX_CStringAbbreviations mNames
Definition: AAX_CParameter.h:1277
AAX_EParameterType GetType() const AAX_OVERRIDE
Returns the type of this parameter as an AAX_EParameterType.
Definition: AAX_CParameter.h:1265
bool GetNormalizedValueFromBool(bool, double *normalizedValue) const AAX_OVERRIDE
Converts a bool to a normalized parameter value.
Definition: AAX_CParameter.h:1234
void UpdateNormalizedValue(double) AAX_OVERRIDE
Sets the parameter's state given a normalized value.
Definition: AAX_CParameter.h:1277
void SetNumberOfSteps(uint32_t) AAX_OVERRIDE
Sets the number of discrete steps for this parameter.
Definition: AAX_CParameter.h:1218
void SetDisplayDelegate(AAX_IDisplayDelegateBase &) AAX_OVERRIDE
Sets the parameter's display delegate.
Definition: AAX_CParameter.h:1271
AAX_EParameterOrientation GetOrientation() const AAX_OVERRIDE
Returns the orientation of this parameter.
Definition: AAX_CParameter.h:1268
bool GetNormalizedValueFromInt32(int32_t, double *normalizedValue) const AAX_OVERRIDE
Converts an integer to a normalized parameter value.
Definition: AAX_CParameter.h:1235
void Release() AAX_OVERRIDE
Signals the automation system that a control has been released.
Definition: AAX_CParameter.h:1206
bool SetValueWithString(const AAX_IString &value) AAX_OVERRIDE
Sets the parameter's value as a string.
Definition: AAX_CParameter.h:1261
AAX_CStatelessParameter(const AAX_IString &identifier, const AAX_IString &name, const AAX_IString &inValueString)
Definition: AAX_CParameter.h:1163
bool GetNormalizedValueFromString(const AAX_CString &, double *normalizedValue) const AAX_OVERRIDE
Converts a given string to a normalized parameter value.
Definition: AAX_CParameter.h:1238
bool GetValueAsFloat(float *) const AAX_OVERRIDE
Retrieves the parameter's value as a float.
Definition: AAX_CParameter.h:1254
bool GetStringFromNormalizedValue(double normalizedValue, int32_t, AAX_CString &valueString) const AAX_OVERRIDE
Converts a normalized parameter value to a string representing the corresponding real,...
Definition: AAX_CParameter.h:1244
void Touch() AAX_OVERRIDE
Signals the automation system that a control has been touched.
Definition: AAX_CParameter.h:1205
void SetNormalizedValue(double) AAX_OVERRIDE
Sets a parameter value using it's normalized representation.
Definition: AAX_CParameter.h:1213
void SetNormalizedDefaultValue(double) AAX_OVERRIDE
Sets the parameter's default value using its normalized representation.
Definition: AAX_CParameter.h:1215
void SetToDefaultValue() AAX_OVERRIDE
Restores the state of this parameter to its default value.
Definition: AAX_CParameter.h:1217
bool Automatable() const AAX_OVERRIDE
Returns true if the parameter is automatable, false if it is not.
Definition: AAX_CParameter.h:1191
bool SetValueWithInt32(int32_t) AAX_OVERRIDE
Sets the parameter's value as an int32_t.
Definition: AAX_CParameter.h:1258
AAX_CParamID Identifier() const AAX_OVERRIDE
Returns the parameter's unique identifier.
Definition: AAX_CParameter.h:1179
bool GetDoubleFromNormalizedValue(double, double *) const AAX_OVERRIDE
Converts a normalized parameter value to a double representing the corresponding real value.
Definition: AAX_CParameter.h:1242
bool GetNormalizedValueFromFloat(float, double *normalizedValue) const AAX_OVERRIDE
Converts a float to a normalized parameter value.
Definition: AAX_CParameter.h:1236
bool SetValueWithBool(bool) AAX_OVERRIDE
Sets the parameter's value as a bool.
Definition: AAX_CParameter.h:1257
AAX_CString mID
Definition: AAX_CParameter.h:1282
AAX_CStatelessParameter(AAX_CParamID identifier, const AAX_IString &name, const AAX_IString &inValueString)
Definition: AAX_CParameter.h:1155
bool SetValueWithFloat(float) AAX_OVERRIDE
Sets the parameter's value as a float.
Definition: AAX_CParameter.h:1259
bool SetValueFromString(const AAX_CString &newValueString) AAX_OVERRIDE
Converts a string to a real parameter value and sets the parameter to this value.
Definition: AAX_CParameter.h:1245
bool GetNormalizedValueFromDouble(double, double *normalizedValue) const AAX_OVERRIDE
Converts a double to a normalized parameter value.
Definition: AAX_CParameter.h:1237
bool GetValueAsString(AAX_IString *) const AAX_OVERRIDE
Retrieves the parameter's value as a string.
Definition: AAX_CParameter.h:1256
void SetAutomationDelegate(AAX_IAutomationDelegate *iAutomationDelegate) AAX_OVERRIDE
Sets the automation delegate (if one is required)
Definition: AAX_CParameter.h:1192
bool GetValueString(AAX_CString *valueString) const AAX_OVERRIDE
Serializes the parameter value into a string.
Definition: AAX_CParameter.h:1232
void SetStepValue(uint32_t) AAX_OVERRIDE
Returns the current step for the current value of the parameter.
Definition: AAX_CParameter.h:1223
void SetType(AAX_EParameterType) AAX_OVERRIDE
Sets the type of this parameter.
Definition: AAX_CParameter.h:1264
AAX_CString mValueString
Definition: AAX_CParameter.h:1284
void SetName(const AAX_CString &name) AAX_OVERRIDE
Sets the parameter's display name.
Definition: AAX_CParameter.h:1180
bool GetFloatFromNormalizedValue(double, float *) const AAX_OVERRIDE
Converts a normalized parameter value to a float representing the corresponding real value.
Definition: AAX_CParameter.h:1241
bool GetValueAsBool(bool *value) const AAX_OVERRIDE
Retrieves the parameter's value as a bool.
Definition: AAX_CParameter.h:1252
AAX_IAutomationDelegate * mAutomationDelegate
Definition: AAX_CParameter.h:1283
AAX_DEFAULT_DTOR_OVERRIDE(AAX_CStatelessParameter)
uint32_t GetNumberOfSteps() const AAX_OVERRIDE
Returns the number of discrete steps used by the parameter.
Definition: AAX_CParameter.h:1219
void SetOrientation(AAX_EParameterOrientation) AAX_OVERRIDE
Sets the orientation of this parameter.
Definition: AAX_CParameter.h:1267
bool GetValueAsDouble(double *) const AAX_OVERRIDE
Retrieves the parameter's value as a double.
Definition: AAX_CParameter.h:1255
A generic AAX string class with similar functionality to std::string
Definition: AAX_CString.h:46
const char * CString() const
const char * Get() const AAX_OVERRIDE
Helper class to store a collection of name abbreviations.
Definition: AAX_CString.h:175
void Clear()
Definition: AAX_CString.h:209
void Add(const AAX_CString &inAbbreviation)
Definition: AAX_CString.h:186
const AAX_CString & Primary() const
Definition: AAX_CString.h:184
void SetPrimary(const AAX_CString &inPrimary)
Definition: AAX_CString.h:183
const AAX_CString & Get(int32_t inNumCharacters) const
Definition: AAX_CString.h:192
Interface allowing an AAX plug-in to interact with the host's event system.
Definition: AAX_IAutomationDelegate.h:47
virtual AAX_Result PostTouchRequest(AAX_CParamID iParameterID)=0
virtual AAX_Result RegisterParameter(AAX_CParamID iParameterID)=0
virtual AAX_Result PostReleaseRequest(AAX_CParamID iParameterID)=0
virtual AAX_Result UnregisterParameter(AAX_CParamID iParameterID)=0
Defines the display behavior for a parameter.
Definition: AAX_IDisplayDelegate.h:53
Classes for parameter value string conversion.
Definition: AAX_IDisplayDelegate.h:69
virtual AAX_IDisplayDelegate * Clone() const =0
Constructs and returns a copy of the display delegate.
An abstract interface representing a parameter value of arbitrary type.
Definition: AAX_IParameter.h:45
The base interface for all normalizable plug-in parameters.
Definition: AAX_IParameter.h:140
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:41
Defines the taper conversion behavior for a parameter.
Definition: AAX_ITaperDelegate.h:73
Classes for conversion to and from normalized parameter values.
Definition: AAX_ITaperDelegate.h:89
virtual AAX_ITaperDelegate * Clone() const =0
Constructs and returns a copy of the taper delegate.