AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_IParameter Class Referenceabstract

#include <AAX_IParameter.h>

Inheritance diagram for AAX_IParameter:
[legend]

Description

The base interface for all normalizable plug-in parameters.

:Internal to the AAX SDK:

This class is an outside interface for an arbitrarily typed parameter. The subclasses of this generic interface hold the parameter's state and conversion functionality.

Note
This class is not part of the AAX ABI and must not be passed between the plug-in and the host. Version checking is recommended when passing references to this interface between plug-in modules (e.g. between the data model and the GUI)

Public Member Functions

virtual ~AAX_IParameter ()
 Virtual destructor. More...
 
virtual AAX_IParameterValueCloneValue () const =0
 Clone the parameter's value to a new AAX_IParameterValue object. More...
 
Identification methods
virtual AAX_CParamID Identifier () const =0
 Returns the parameter's unique identifier. More...
 
virtual void SetName (const AAX_CString &name)=0
 Sets the parameter's display name. More...
 
virtual const AAX_CStringName () const =0
 Returns the parameter's display name. More...
 
virtual void AddShortenedName (const AAX_CString &name)=0
 Sets the parameter's shortened display name. More...
 
virtual const AAX_CStringShortenedName (int32_t iNumCharacters) const =0
 Returns the parameter's shortened display name. More...
 
virtual void ClearShortenedNames ()=0
 Clears the internal list of shortened display names. More...
 
Automation methods
virtual bool Automatable () const =0
 Returns true if the parameter is automatable, false if it is not. More...
 
virtual void SetAutomationDelegate (AAX_IAutomationDelegate *iAutomationDelegate)=0
 Sets the automation delegate (if one is required) More...
 
virtual void Touch ()=0
 Signals the automation system that a control has been touched. More...
 
virtual void Release ()=0
 Signals the automation system that a control has been released. More...
 
Taper methods
virtual void SetNormalizedValue (double newNormalizedValue)=0
 Sets a parameter value using it's normalized representation. More...
 
virtual double GetNormalizedValue () const =0
 Returns the normalized representation of the parameter's current real value. More...
 
virtual void SetNormalizedDefaultValue (double normalizedDefault)=0
 Sets the parameter's default value using its normalized representation. More...
 
virtual double GetNormalizedDefaultValue () const =0
 Returns the normalized representation of the parameter's real default value. More...
 
virtual void SetToDefaultValue ()=0
 Restores the state of this parameter to its default value. More...
 
virtual void SetNumberOfSteps (uint32_t numSteps)=0
 Sets the number of discrete steps for this parameter. More...
 
virtual uint32_t GetNumberOfSteps () const =0
 Returns the number of discrete steps used by the parameter. More...
 
virtual uint32_t GetStepValue () const =0
 Returns the current step for the current value of the parameter. More...
 
virtual double GetNormalizedValueFromStep (uint32_t iStep) const =0
 Returns the normalized value for a given step. More...
 
virtual uint32_t GetStepValueFromNormalizedValue (double normalizedValue) const =0
 Returns the step value for a normalized value of the parameter. More...
 
virtual void SetStepValue (uint32_t iStep)=0
 Returns the current step for the current value of the parameter. More...
 
Display methods

This functionality is most often used by GUIs, but can also be useful for state serialization.

virtual bool GetValueString (AAX_CString *valueString) const =0
 Serializes the parameter value into a string. More...
 
virtual bool GetValueString (int32_t iMaxNumChars, AAX_CString *valueString) const =0
 Serializes the parameter value into a string, size hint included. More...
 
virtual bool GetNormalizedValueFromBool (bool value, double *normalizedValue) const =0
 Converts a bool to a normalized parameter value. More...
 
virtual bool GetNormalizedValueFromInt32 (int32_t value, double *normalizedValue) const =0
 Converts an integer to a normalized parameter value. More...
 
virtual bool GetNormalizedValueFromFloat (float value, double *normalizedValue) const =0
 Converts a float to a normalized parameter value. More...
 
virtual bool GetNormalizedValueFromDouble (double value, double *normalizedValue) const =0
 Converts a double to a normalized parameter value. More...
 
virtual bool GetNormalizedValueFromString (const AAX_CString &valueString, double *normalizedValue) const =0
 Converts a given string to a normalized parameter value. More...
 
virtual bool GetBoolFromNormalizedValue (double normalizedValue, bool *value) const =0
 Converts a normalized parameter value to a bool representing the corresponding real value. More...
 
virtual bool GetInt32FromNormalizedValue (double normalizedValue, int32_t *value) const =0
 Converts a normalized parameter value to an integer representing the corresponding real value. More...
 
virtual bool GetFloatFromNormalizedValue (double normalizedValue, float *value) const =0
 Converts a normalized parameter value to a float representing the corresponding real value. More...
 
virtual bool GetDoubleFromNormalizedValue (double normalizedValue, double *value) const =0
 Converts a normalized parameter value to a double representing the corresponding real value. More...
 
virtual bool GetStringFromNormalizedValue (double normalizedValue, AAX_CString &valueString) const =0
 Converts a normalized parameter value to a string representing the corresponding real value. More...
 
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, size hint included. value. More...
 
virtual bool SetValueFromString (const AAX_CString &newValueString)=0
 Converts a string to a real parameter value and sets the parameter to this value. More...
 
Typed accessors
virtual bool GetValueAsBool (bool *value) const =0
 Retrieves the parameter's value as a bool. More...
 
virtual bool GetValueAsInt32 (int32_t *value) const =0
 Retrieves the parameter's value as an int32_t. More...
 
virtual bool GetValueAsFloat (float *value) const =0
 Retrieves the parameter's value as a float. More...
 
virtual bool GetValueAsDouble (double *value) const =0
 Retrieves the parameter's value as a double. More...
 
virtual bool GetValueAsString (AAX_IString *value) const =0
 Retrieves the parameter's value as a string. More...
 
virtual bool SetValueWithBool (bool value)=0
 Sets the parameter's value as a bool. More...
 
virtual bool SetValueWithInt32 (int32_t value)=0
 Sets the parameter's value as an int32_t. More...
 
virtual bool SetValueWithFloat (float value)=0
 Sets the parameter's value as a float. More...
 
virtual bool SetValueWithDouble (double value)=0
 Sets the parameter's value as a double. More...
 
virtual bool SetValueWithString (const AAX_IString &value)=0
 Sets the parameter's value as a string. More...
 
virtual void SetType (AAX_EParameterType iControlType)=0
 Sets the type of this parameter. More...
 
virtual AAX_EParameterType GetType () const =0
 Returns the type of this parameter as an AAX_EParameterType. More...
 
virtual void SetOrientation (AAX_EParameterOrientation iOrientation)=0
 Sets the orientation of this parameter. More...
 
virtual AAX_EParameterOrientation GetOrientation () const =0
 Returns the orientation of this parameter. More...
 
virtual void SetTaperDelegate (AAX_ITaperDelegateBase &inTaperDelegate, bool inPreserveValue)=0
 Sets the parameter's taper delegate. More...
 
virtual void SetDisplayDelegate (AAX_IDisplayDelegateBase &inDisplayDelegate)=0
 Sets the parameter's display delegate. More...
 
Host interface methods
virtual void UpdateNormalizedValue (double newNormalizedValue)=0
 Sets the parameter's state given a normalized value. More...
 

Constructor & Destructor Documentation

◆ ~AAX_IParameter()

virtual AAX_IParameter::~AAX_IParameter ( )
inlinevirtual

Virtual destructor.

Note
This destructor MUST be virtual to prevent memory leaks.

Member Function Documentation

◆ CloneValue()

virtual AAX_IParameterValue* AAX_IParameter::CloneValue ( ) const
pure virtual

Clone the parameter's value to a new AAX_IParameterValue object.

The returned object is independent from the AAX_IParameter. For example, changing the state of the returned object will not result in a change to the original AAX_IParameter.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

Referenced by AAX_CMonolithicParameters::GenerateCoefficients().

Here is the caller graph for this function:

◆ Identifier()

virtual AAX_CParamID AAX_IParameter::Identifier ( ) const
pure virtual

Returns the parameter's unique identifier.

This unique ID is used by the Parameter Manager and by outside applications to uniquely identify and target control messages. This value may not be changed after the parameter has been constructed.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

Referenced by AAX_CMonolithicParameters::AddSynchronizedParameter(), and AAX_CMonolithicParameters::GenerateCoefficients().

Here is the caller graph for this function:

◆ SetName()

virtual void AAX_IParameter::SetName ( const AAX_CString name)
pure virtual

Sets the parameter's display name.

This name is used for display only, it is not used for indexing or identifying the parameter This name may be changed after the parameter has been created, but display name changes may not be recognized by all AAX hosts.

Parameters
[in]nameDisplay name that will be assigned to the parameter

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ Name()

virtual const AAX_CString& AAX_IParameter::Name ( ) const
pure virtual

Returns the parameter's display name.

Note
This method returns a const reference in order to prevent a string copy. Do not cast away the const to change this value.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ AddShortenedName()

virtual void AAX_IParameter::AddShortenedName ( const AAX_CString name)
pure virtual

Sets the parameter's shortened display name.

This name is used for display only, it is not used for indexing or identifying the parameter These names show up when the host asks for shorter length parameter names for display on Control Surfaces or other string length constrained situations.

Parameters
[in]nameShortened display names that will be assigned to the parameter

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ ShortenedName()

virtual const AAX_CString& AAX_IParameter::ShortenedName ( int32_t  iNumCharacters) const
pure virtual

Returns the parameter's shortened display name.

Note
This method returns a const reference in order to prevent a string copy. Do not cast away the const to change this value.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ ClearShortenedNames()

virtual void AAX_IParameter::ClearShortenedNames ( )
pure virtual

Clears the internal list of shortened display names.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ Automatable()

virtual bool AAX_IParameter::Automatable ( ) const
pure virtual

Returns true if the parameter is automatable, false if it is not.

Note
Subclasses that return true in this method must support host-based automation.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

Referenced by AAX_CMonolithicParameters::AddSynchronizedParameter().

Here is the caller graph for this function:

◆ SetAutomationDelegate()

virtual void AAX_IParameter::SetAutomationDelegate ( AAX_IAutomationDelegate iAutomationDelegate)
pure virtual

Sets the automation delegate (if one is required)

Parameters
[in]iAutomationDelegateA reference to the parameter manager's automation delegate interface

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ Touch()

virtual void AAX_IParameter::Touch ( )
pure virtual

Signals the automation system that a control has been touched.

Call this method in response to GUI events that begin editing, such as a mouse down. After this method has been called you are free to call SetNormalizedValue() as much as you need, e.g. in order to respond to subsequent mouse moved events. Call Release() to free the parameter for updates from other controls.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ Release()

virtual void AAX_IParameter::Release ( )
pure virtual

Signals the automation system that a control has been released.

Call this method in response to GUI events that complete editing, such as a mouse up. Once this method has been called you should not call SetNormalizedValue() again until after the next call to Touch().

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetNormalizedValue()

virtual void AAX_IParameter::SetNormalizedValue ( double  newNormalizedValue)
pure virtual

Sets a parameter value using it's normalized representation.

For more information regarding normalized values, see Parameter Manager

Parameters
[in]newNormalizedValueNew value (normalized) to which the parameter will be set

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetNormalizedValue()

virtual double AAX_IParameter::GetNormalizedValue ( ) const
pure virtual

Returns the normalized representation of the parameter's current real value.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetNormalizedDefaultValue()

virtual void AAX_IParameter::SetNormalizedDefaultValue ( double  normalizedDefault)
pure virtual

Sets the parameter's default value using its normalized representation.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetNormalizedDefaultValue()

virtual double AAX_IParameter::GetNormalizedDefaultValue ( ) const
pure virtual

Returns the normalized representation of the parameter's real default value.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetToDefaultValue()

virtual void AAX_IParameter::SetToDefaultValue ( )
pure virtual

Restores the state of this parameter to its default value.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetNumberOfSteps()

virtual void AAX_IParameter::SetNumberOfSteps ( uint32_t  numSteps)
pure virtual

Sets the number of discrete steps for this parameter.

Stepped parameter values are useful for discrete parameters and for "jumping" events such as mouse wheels, page up/down, etc. The parameter's step size is used to specify the coarseness of those changes.

Note
numSteps MUST be greater than zero. All other values may be considered an error by the host.
Parameters
[in]numStepsThe number of steps that the parameter will use

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetNumberOfSteps()

virtual uint32_t AAX_IParameter::GetNumberOfSteps ( ) const
pure virtual

Returns the number of discrete steps used by the parameter.

See SetNumberOfSteps() for more information about parameter steps.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetStepValue()

virtual uint32_t AAX_IParameter::GetStepValue ( ) const
pure virtual

Returns the current step for the current value of the parameter.

See SetNumberOfSteps() for more information about parameter steps.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetNormalizedValueFromStep()

virtual double AAX_IParameter::GetNormalizedValueFromStep ( uint32_t  iStep) const
pure virtual

Returns the normalized value for a given step.

See SetNumberOfSteps() for more information about parameter steps.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetStepValueFromNormalizedValue()

virtual uint32_t AAX_IParameter::GetStepValueFromNormalizedValue ( double  normalizedValue) const
pure virtual

Returns the step value for a normalized value of the parameter.

See SetNumberOfSteps() for more information about parameter steps.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetStepValue()

virtual void AAX_IParameter::SetStepValue ( uint32_t  iStep)
pure virtual

Returns the current step for the current value of the parameter.

See SetNumberOfSteps() for more information about parameter steps.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetValueString() [1/2]

virtual bool AAX_IParameter::GetValueString ( AAX_CString valueString) const
pure virtual

Serializes the parameter value into a string.

Parameters
[out]valueStringA string representing the parameter's real value
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetValueString() [2/2]

virtual bool AAX_IParameter::GetValueString ( int32_t  iMaxNumChars,
AAX_CString valueString 
) const
pure virtual

Serializes the parameter value into a string, size hint included.

Parameters
[in]iMaxNumCharsA size hint for the size of the string being requested. Useful for control surfaces and other limited area text fields. (make sure that size of desired string also has room for null termination)
[out]valueStringA string representing the parameter's real value
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetNormalizedValueFromBool()

virtual bool AAX_IParameter::GetNormalizedValueFromBool ( bool  value,
double *  normalizedValue 
) const
pure virtual

Converts a bool to a normalized parameter value.

Parameters
[in]valueA value for the parameter
[out]normalizedValueThe normalized parameter value associated with value
Return values
trueThe value conversion was successful
falseThe value conversion was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetNormalizedValueFromInt32()

virtual bool AAX_IParameter::GetNormalizedValueFromInt32 ( int32_t  value,
double *  normalizedValue 
) const
pure virtual

Converts an integer to a normalized parameter value.

Parameters
[in]valueA value for the parameter
[out]normalizedValueThe normalized parameter value associated with value
Return values
trueThe value conversion was successful
falseThe value conversion was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetNormalizedValueFromFloat()

virtual bool AAX_IParameter::GetNormalizedValueFromFloat ( float  value,
double *  normalizedValue 
) const
pure virtual

Converts a float to a normalized parameter value.

Parameters
[in]valueA value for the parameter
[out]normalizedValueThe normalized parameter value associated with value
Return values
trueThe value conversion was successful
falseThe value conversion was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetNormalizedValueFromDouble()

virtual bool AAX_IParameter::GetNormalizedValueFromDouble ( double  value,
double *  normalizedValue 
) const
pure virtual

Converts a double to a normalized parameter value.

Parameters
[in]valueA value for the parameter
[out]normalizedValueThe normalized parameter value associated with value
Return values
trueThe value conversion was successful
falseThe value conversion was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetNormalizedValueFromString()

virtual bool AAX_IParameter::GetNormalizedValueFromString ( const AAX_CString valueString,
double *  normalizedValue 
) const
pure virtual

Converts a given string to a normalized parameter value.

Parameters
[in]valueStringA string representing a possible real value for the parameter
[out]normalizedValueThe normalized parameter value associated with valueString
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ GetBoolFromNormalizedValue()

virtual bool AAX_IParameter::GetBoolFromNormalizedValue ( double  normalizedValue,
bool *  value 
) const
pure virtual

Converts a normalized parameter value to a bool representing the corresponding real value.

Parameters
[in]normalizedValueThe normalized value to convert
[out]valueThe converted value. Set only if conversion is successful.
Return values
trueThe conversion to bool was successful
falseThe conversion to bool was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetInt32FromNormalizedValue()

virtual bool AAX_IParameter::GetInt32FromNormalizedValue ( double  normalizedValue,
int32_t *  value 
) const
pure virtual

Converts a normalized parameter value to an integer representing the corresponding real value.

Parameters
[in]normalizedValueThe normalized value to convert
[out]valueThe converted value. Set only if conversion is successful.
Return values
trueThe conversion to int32_t was successful
falseThe conversion to int32_t was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetFloatFromNormalizedValue()

virtual bool AAX_IParameter::GetFloatFromNormalizedValue ( double  normalizedValue,
float *  value 
) const
pure virtual

Converts a normalized parameter value to a float representing the corresponding real value.

Parameters
[in]normalizedValueThe normalized value to convert
[out]valueThe converted value. Set only if conversion is successful.
Return values
trueThe conversion to float was successful
falseThe conversion to float was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetDoubleFromNormalizedValue()

virtual bool AAX_IParameter::GetDoubleFromNormalizedValue ( double  normalizedValue,
double *  value 
) const
pure virtual

Converts a normalized parameter value to a double representing the corresponding real value.

Parameters
[in]normalizedValueThe normalized value to convert
[out]valueThe converted value. Set only if conversion is successful.
Return values
trueThe conversion to double was successful
falseThe conversion to double was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ GetStringFromNormalizedValue() [1/2]

virtual bool AAX_IParameter::GetStringFromNormalizedValue ( double  normalizedValue,
AAX_CString valueString 
) const
pure virtual

Converts a normalized parameter value to a string representing the corresponding real value.

Parameters
[in]normalizedValueA normalized parameter value
[out]valueStringA string representing the parameter value associated with normalizedValue
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetStringFromNormalizedValue() [2/2]

virtual bool AAX_IParameter::GetStringFromNormalizedValue ( double  normalizedValue,
int32_t  iMaxNumChars,
AAX_CString valueString 
) const
pure virtual

Converts a normalized parameter value to a string representing the corresponding real, size hint included. value.

Parameters
[in]normalizedValueA normalized parameter value
[in]iMaxNumCharsA size hint for the size of the string being requested. Useful for control surfaces and other limited area text fields. (make sure that size of desired string also has room for null termination)
[out]valueStringA string representing the parameter value associated with normalizedValue
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetValueFromString()

virtual bool AAX_IParameter::SetValueFromString ( const AAX_CString newValueString)
pure virtual

Converts a string to a real parameter value and sets the parameter to this value.

Parameters
[in]newValueStringA string representing the parameter's new real value
Return values
trueThe string conversion was successful
falseThe string conversion was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetValueAsBool()

virtual bool AAX_IParameter::GetValueAsBool ( bool *  value) const
pure virtual

Retrieves the parameter's value as a bool.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion to bool was successful
falseThe conversion to bool was unsuccessful

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetValueAsInt32()

virtual bool AAX_IParameter::GetValueAsInt32 ( int32_t *  value) const
pure virtual

Retrieves the parameter's value as an int32_t.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion to int32_t was successful
falseThe conversion to int32_t was unsuccessful

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ GetValueAsFloat()

virtual bool AAX_IParameter::GetValueAsFloat ( float *  value) const
pure virtual

Retrieves the parameter's value as a float.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion to float was successful
falseThe conversion to float was unsuccessful

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ GetValueAsDouble()

virtual bool AAX_IParameter::GetValueAsDouble ( double *  value) const
pure virtual

Retrieves the parameter's value as a double.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion to double was successful
falseThe conversion to double was unsuccessful

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ GetValueAsString()

virtual bool AAX_IParameter::GetValueAsString ( AAX_IString value) const
pure virtual

Retrieves the parameter's value as a string.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion to string was successful
falseThe conversion to string was unsuccessful

Implemented in AAX_CParameter< T >, AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetValueWithBool()

virtual bool AAX_IParameter::SetValueWithBool ( bool  value)
pure virtual

Sets the parameter's value as a bool.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion from bool was successful
falseThe conversion from bool was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ SetValueWithInt32()

virtual bool AAX_IParameter::SetValueWithInt32 ( int32_t  value)
pure virtual

Sets the parameter's value as an int32_t.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion from int32_t was successful
falseThe conversion from int32_t was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ SetValueWithFloat()

virtual bool AAX_IParameter::SetValueWithFloat ( float  value)
pure virtual

Sets the parameter's value as a float.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion from float was successful
falseThe conversion from float was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ SetValueWithDouble()

virtual bool AAX_IParameter::SetValueWithDouble ( double  value)
pure virtual

Sets the parameter's value as a double.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion from double was successful
falseThe conversion from double was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ SetValueWithString()

virtual bool AAX_IParameter::SetValueWithString ( const AAX_IString value)
pure virtual

Sets the parameter's value as a string.

Parameters
[out]valueThe parameter's real value. Set only if conversion is successful.
Return values
trueThe conversion from string was successful
falseThe conversion from string was unsuccessful

Implemented in AAX_CStatelessParameter, AAX_CParameter< T >, and AAX_CParameter< T >.

◆ SetType()

virtual void AAX_IParameter::SetType ( AAX_EParameterType  iControlType)
pure virtual

Sets the type of this parameter.

See GetType for use cases

Parameters
[in]iControlTypeThe parameter's new type as an AAX_EParameterType

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetType()

virtual AAX_EParameterType AAX_IParameter::GetType ( ) const
pure virtual

Returns the type of this parameter as an AAX_EParameterType.

Todo:
Document use cases for control type

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetOrientation()

virtual void AAX_IParameter::SetOrientation ( AAX_EParameterOrientation  iOrientation)
pure virtual

Sets the orientation of this parameter.

Parameters
[in]iOrientationThe parameter's new orientation

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ GetOrientation()

virtual AAX_EParameterOrientation AAX_IParameter::GetOrientation ( ) const
pure virtual

Returns the orientation of this parameter.

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.

◆ SetTaperDelegate()

virtual void AAX_IParameter::SetTaperDelegate ( AAX_ITaperDelegateBase inTaperDelegate,
bool  inPreserveValue 
)
pure virtual

Sets the parameter's taper delegate.

Parameters
[in]inTaperDelegateA reference to the parameter's new taper delegate
[in]inPreserveValue
Todo:
Document this parameter

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ SetDisplayDelegate()

virtual void AAX_IParameter::SetDisplayDelegate ( AAX_IDisplayDelegateBase inDisplayDelegate)
pure virtual

Sets the parameter's display delegate.

Parameters
[in]inDisplayDelegateA reference to the parameter's new display delegate

Implemented in AAX_CParameter< T >, and AAX_CStatelessParameter.

◆ UpdateNormalizedValue()

virtual void AAX_IParameter::UpdateNormalizedValue ( double  newNormalizedValue)
pure virtual

Sets the parameter's state given a normalized value.

This is the second half of the parameter setting operation that is initiated with a call to SetValue(). Parameters should not be set directly using this method; instead, use SetValue().

Parameters
[in]newNormalizedValueNormalized value that will be used to set the parameter's new state

Implemented in AAX_CStatelessParameter, and AAX_CParameter< T >.


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