docs » cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels


Color Wheels Module.

Requires Final Cut Pro 10.4 or later.

API Overview

API Documentation

Constants

VIEW_MODES

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels.VIEW_MODES -> table
Type Constant
Description View Modes for Color Wheels

Methods

app

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:app() -> table
Type Method
Description Returns the cp.apple.finalcutpro app table
Parameters
  • None
Returns
  • The application object as a table

isShowing

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:isShowing() -> boolean
Type Method
Description Is the Color Wheels currently showing?
Parameters
  • None
Returns
  • `true` if showing, otherwise `false`

new

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:new(parent) -> ColorInspector object
Type Method
Description Creates a new ColorWheels object
Parameters
  • `parent` - The parent
Returns
  • A ColorInspector object

parent

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:parent() -> table
Type Method
Description Returns the ColorWheels's parent table
Parameters
  • None
Returns
  • The parent object as a table

show

Signature cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:show() -> boolean
Type Method
Description Show's the Color Board within the Color Inspector.
Parameters
  • None
Returns
  • ColorWheels object

viewMode

Signature `cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels:viewMode([value]) -> string nil` </span>
Type Method
Description Sets or gets the View Mode for the Color Wheels.
Parameters
  • [value] - An optional value to set the View Mode, as defined in `cp.apple.finalcutpro.main.Inspector.ColorInspector.ColorWheels.VIEW_MODES`.
Returns
  • A string containing the View Mode or `nil` if an error occurs.
Notes
  • Value can be:
  • All Wheels
  • Single Wheels

results matching ""

    No results matching ""