#cp.apple.finalcutpro.inspector.color.HueSaturationCurves

Color Curves Module.

Requires Final Cut Pro 10.4 or later.

#API Overview

Functions - API calls offered directly by the extension

Constructors - API calls which return an object, typically one that offers API methods

Fields - Variables which can only be accessed from an object returned by a constructor

Methods - API calls which can only be made on an object returned by a constructor


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.matches(element)`
Type	Function
Description	Checks if the specified element is the Color Curves element.
Parameters	element - The element to check
Returns	`true` if the element is the Color Curves.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 43


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves(parent) -> HueSaturationCurves object`
Type	Constructor
Description	Creates a new HueSaturationCurves object
Parameters	`parent` - The parent
Returns	A ColorInspector object
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 62


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.colorVsSat <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 227


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.contentUI <cp.prop: hs.axuielement; read-only>`
Type	Field
Description	The `axuielement` representing the content element of the HueSaturationCurves corrector.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 117


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsHue <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 187


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsLuma <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 203


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsSat <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 195


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.lumaVsSat <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 211


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mix <cp.prop: number>`
Type	Field
Description	The mix amount for this corrector. A number ranging from `0` to `1`.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 266


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mixRow <cp.ui.PropertyRow>`
Type	Field
Description	A `PropertyRow` that provides access to the 'Mix' parameter, and `axuielement`
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 236


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mixSlider <cp.ui.Slider>`
Type	Field
Description	A `Slider` that provides access to the 'Mix' slider.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 244


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.satVsSat <HueSaturationCurve>`
Type	Field
Description	A HueSaturationCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 219


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.viewingAllCurves <cp.prop: boolean>`
Type	Field
Description	Reports and modifies whether the corrector is showing "All Curves" (`true`) or "Single Curves" (`false`).
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 143


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.viewModeButton <cp.ui.MenuButton>`
Type	Field
Description	The MenuButton for the View Mode.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 130


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves.wheelType <RadioGroup>`
Type	Field
Description	The `RadioGroup` that allows selection of the curve type. Only available when
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 170


Signature	`cp.apple.finalcutpro.inspector.color.HueSaturationCurves:show() -> boolean`
Type	Method
Description	Show's the Color Board within the Color Inspector.
Parameters	None
Returns	HueSaturationCurves object
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 95