# 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_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [HueSaturationCurves](#huesaturationcurves) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [colorVsSat](#colorvssat) * [contentUI](#contentui) * [hueVsHue](#huevshue) * [hueVsLuma](#huevsluma) * [hueVsSat](#huevssat) * [lumaVsSat](#lumavssat) * [mix](#mix) * [mixRow](#mixrow) * [mixSlider](#mixslider) * [satVsSat](#satvssat) * [viewingAllCurves](#viewingallcurves) * [viewModeButton](#viewmodebutton) * [wheelType](#wheeltype) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [show](#show) --- ## API Documentation #### Functions ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.matches(element)` | | **Type** | Function | | **Description** | Checks if the specified element is the Color Curves element. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 43](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L43) | --- #### Constructors ### [HueSaturationCurves](#huesaturationcurves) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves(parent) -> HueSaturationCurves object` | | **Type** | Constructor | | **Description** | Creates a new HueSaturationCurves object | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 62](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L62) | --- #### Fields ### [colorVsSat](#colorvssat) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.colorVsSat ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 227](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L227) | --- ### [contentUI](#contentui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.contentUI ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L117) | --- ### [hueVsHue](#huevshue) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsHue ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 187](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L187) | --- ### [hueVsLuma](#huevsluma) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsLuma ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 203](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L203) | --- ### [hueVsSat](#huevssat) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.hueVsSat ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 195](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L195) | --- ### [lumaVsSat](#lumavssat) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.lumaVsSat ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 211](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L211) | --- ### [mix](#mix) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mix ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L266) | --- ### [mixRow](#mixrow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mixRow ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L236) | --- ### [mixSlider](#mixslider) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.mixSlider ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L244) | --- ### [satVsSat](#satvssat) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.satVsSat ` | | **Type** | Field | | **Description** | A [HueSaturationCurve](cp.apple.finalcutpro.inspector.color.HueSaturationCurve.md) | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 219](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L219) | --- ### [viewingAllCurves](#viewingallcurves) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.viewingAllCurves ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L143) | --- ### [viewModeButton](#viewmodebutton) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.viewModeButton ` | | **Type** | Field | | **Description** | The [MenuButton](cp.ui.MenuButton.md) for the View Mode. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua line 130](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L130) | --- ### [wheelType](#wheeltype) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.HueSaturationCurves.wheelType ` | | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L170) | --- #### Methods ### [show](#show) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **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](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/HueSaturationCurves.lua#L95) | --- ---