Contents

addAngleSlider(withName:parameterID:defaultDegrees:parameterMinDegrees:parameterMaxDegrees:parameterFlags:)

Creates an angle slider parameter and adds it to the plug-in’s parameter list.

Declaration

func addAngleSlider(withName name: String, parameterID: UInt32, defaultDegrees: Double, parameterMinDegrees minDegrees: Double, parameterMaxDegrees maxDegrees: Double, parameterFlags flags: FxParameterFlags) -> Bool

Parameters

  • name:

    Name of the parameter in the user interface.

  • parameterID:

    Unique identifier for a parameter. Used to retrieve, set, or validate the parameter.

  • defaultDegrees:

    Initial angle value for the parameter, in counter-clockwise degrees.

  • minDegrees:

    Minimum value for the parameter, in counter-clockwise degrees.

  • maxDegrees:

    Maximum value for the parameter, in counter-clockwise degrees.

  • flags:

    Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates an angle slider parameter; NO otherwise.

Discussion

The min, max, and default values are expressed in degrees. Use getFloatValue(_:fromParameter:at:) to retrieve the angle parameter value in radians.

See Also

Instance Methods