Getting Started
Lua
Contributing
Control CommandPost
Plugins
Internationalisation
Final Cut Pro
Bundled Extensions
CommandPost API
Bundled Plugins API
Hammerspoon API
Have an account? Sign in

HueSaturationCurves

Last updated 23 days ago

Hue/Saturation Curves Module.

Requires Final Cut Pro 10.4 or later.

API Overview

  • Constants - Useful values which cannot be changed

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

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

API Documentation

Constants

CURVES

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves.CURVES -> table

Type

Constant

Description

Table containing all the different types of Color Curves

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves.VIEW_MODES -> table

Type

Constant

Description

View Modes for Color Curves

Constructors

new

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves.new(parent) -> HueSaturationCurves object

Type

Constructor

Description

Creates a new HueSaturationCurves object

Parameters

Returns

Methods

app

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves:app() -> table

Type

Method

Description

Returns the cp.apple.finalcutpro app table

Parameters

Returns

isShowing

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves:isShowing() -> boolean

Type

Method

Description

Is the Hue/Saturation Curves panel currently showing?

Parameters

Returns

mix

Signature

`cp.apple.finalcutpro.inspector.color.HueSaturationCurves:mix([value]) -> number

nil` </span>

Type

Method

Description

Sets or gets the Hue/Saturation Curves mix value.

Parameters

Returns

parent

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves:parent() -> table

Type

Method

Description

Returns the HueSaturationCurves's parent table

Parameters

Returns

show

Signature

cp.apple.finalcutpro.inspector.color.HueSaturationCurves:show() -> boolean

Type

Method

Description

Show's the Color Board within the Color Inspector.

Parameters

Returns

viewMode

Signature

`cp.apple.finalcutpro.inspector.color.HueSaturationCurves:viewMode([value]) -> string

nil` </span>

Type

Method

Description

Sets or gets the View Mode for the Hue/Saturation Curves.

Parameters

Returns

Notes

Signature

`cp.apple.finalcutpro.inspector.color.HueSaturationCurves:visibleCurve([value]) -> string

nil` </span>

Type

Method

Description

Sets or gets the selected hue/saturation curve.

Parameters

Returns

Notes