cp.apple.finalcutpro.inspector.color.ColorWheels

Color Wheels Module.

Extends Element

API Overview

Functions - API calls offered directly by the extension

  • matches

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

  • ColorWheels

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

  • blackPoint
  • brightness
  • contentUI
  • contrast
  • exposure
  • highlights
  • highlightsTint
  • highlightsWarmth
  • hue
  • hueRow
  • hueSlider
  • hueTextField
  • master
  • maxValue
  • midtones
  • midtonesTint
  • midtonesWarmth
  • minValue
  • mix
  • mixRow
  • mixSlider
  • mixTextField
  • saturation
  • shadows
  • shadowsTint
  • shadowsWarmth
  • temperature
  • temperatureRow
  • temperatureSlider
  • temperatureTextField
  • tint
  • tintRow
  • tintSlider
  • tintTextField
  • value
  • viewingAllWheels
  • viewMode
  • wheelType

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

  • doShow
  • show

API Documentation

Functions

matches

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

Constructors

ColorWheels

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

Fields

blackPoint

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.blackPoint <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 504

brightness

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.brightness <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 375

contentUI

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

contrast

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.contrast <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 332

exposure

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.exposure <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 289

highlights

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.highlights <ColorWheel>
Type Field
Description A ColorWheel that allows control of the 'highlights' color settings.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 249

highlightsTint

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.highlightsTint <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 633

highlightsWarmth

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.highlightsWarmth <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 590

hue

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.hue <cp.prop: number>
Type Field
Description The hue for the corrector. A number from 0 to 360.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 154

hueRow

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.hueRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the 'Hue' parameter, and axuielement
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 359

hueSlider

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.hueSlider <cp.ui.Slider>
Type Field
Description Returns a Slider that provides access to the 'Hue' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 367

hueTextField

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.hueTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the 'Hue' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 379

master

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.master <ColorWheel>
Type Field
Description A ColorWheel that allows control of the 'master' color settings.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 228

maxValue

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.maxValue <cp.prop: number>
Type Field
Description The maximum value of the indicator as a number.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 119

midtones

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.midtones <ColorWheel>
Type Field
Description A ColorWheel that allows control of the 'midtones' color settings.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 242

midtonesTint

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.midtonesTint <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 719

midtonesWarmth

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.midtonesWarmth <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 676

minValue

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.minValue <cp.prop: number>
Type Field
Description The minimum value of the indicator as a number.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 110

mix

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.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/ColorWheels.lua line 133

mixRow

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.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/ColorWheels.lua line 260

mixSlider

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.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/ColorWheels.lua line 268

mixTextField

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.mixTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the 'Mix' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 280

saturation

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.saturation <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 418

shadows

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.shadows <ColorWheel>
Type Field
Description A ColorWheel that allows control of the 'shadows' color settings.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 235

shadowsTint

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.shadowsTint <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 805

shadowsWarmth

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.shadowsWarmth <cp.prop: number>
Type Field
Description The amount for this corrector.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorAdjustments.lua line 762

temperature

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.temperature <cp.prop: number>
Type Field
Description The color temperature for this corrector. A number from 2500 to 10000.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 140

temperatureRow

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the 'Temperatures' parameter, and axuielement
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 293

temperatureSlider

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureSlider <cp.ui.Slider>
Type Field
Description A Slider that provides access to the 'Temperatures' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 301

temperatureTextField

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.temperatureTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the 'Temperature' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 313

tint

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.tint <cp.prop: number>
Type Field
Description The tint for the corrector. A number from -50 to 50.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 147

tintRow

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.tintRow <cp.ui.PropertyRow>
Type Field
Description A PropertyRow that provides access to the 'Tint' parameter, and axuielement
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 326

tintSlider

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.tintSlider <cp.ui.Slider>
Type Field
Description Returns a Slider that provides access to the 'Tint' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 334

tintTextField

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.tintTextField <cp.ui.TextField>
Type Field
Description A TextField that provides access to the 'Tint' slider.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 346

value

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.value <cp.prop: number>
Type Field
Description The value of the value indicator as a number.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ValueIndicator.lua line 63

viewingAllWheels

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

viewMode

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels.viewMode <cp.ui.MenuButton>
Type Field
Description The MenuButton for the View Mode.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 198

wheelType

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

Methods

doShow

   
Signature cp.apple.finalcutpro.inspector.color.ColorWheels:doShow() -> cs.rx.go.Statement
Type Method
Description A Statement that shows the Color Board within the Color Inspector.
Parameters
  • None
Returns
  • The Statement, resolving to true if successfully shown.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheels.lua line 183

show

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

© Copyright 2026 LateNite Films Pty Ltd. All rights reserved.