#cp.apple.finalcutpro.inspector.color.ColorCurves

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.ColorCurves.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/ColorCurves.lua line 48


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


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.blue <ColorCurve>`
Type	Field
Description	A ColorCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 217


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


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.green <ColorCurve>`
Type	Field
Description	A ColorCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 208


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.luma <ColorCurve>`
Type	Field
Description	A ColorCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 191


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.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/ColorCurves.lua line 255


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


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.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/ColorCurves.lua line 233


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.preserveLuma <cp.ui.CheckBox>`
Type	Field
Description	Returns a CheckBox that provides access to the 'Preserve Luma' slider.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 270


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.preserveLumaRow <cp.ui.PropertyRow>`
Type	Field
Description	A `PropertyRow` that provides access to the 'Preserve Luma' parameter, and `axuielement`
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 262


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.red <ColorCurve>`
Type	Field
Description	A ColorCurve
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorCurves.lua line 199


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.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/ColorCurves.lua line 147


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


Signature	`cp.apple.finalcutpro.inspector.color.ColorCurves.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/ColorCurves.lua line 174


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