Contents

addPointParameter(withName:parameterID:defaultX:defaultY:parameterFlags:)

Creates a position point parameter and adds it to the plug-in’s parameter list.

Declaration

func addPointParameter(withName name: String, parameterID: UInt32, defaultX: Double, defaultY: 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.

  • defaultX:

    Initial x value of the position parameter in float ( 0.0 - 1.0 from bottom-left ) space.

  • defaultY:

    Initial y value of the position parameter in float ( 0.0 - 1.0 from bottom-left ) space.

  • flags:

    Flags that encode various state values for the parameter.

Return Value

Returns YES if the application successfully creates a position parameter; NO otherwise.

See Also

Instance Methods