#cp.apple.finalcutpro.inspector.color.ColorWheel

Represents a single Color Well in the Color Wheels Inspector.

#API Overview

Constants - Useful values which cannot be changed

TYPE

Functions - API calls offered directly by the extension

matches

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

ColorWheel

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

brightnessValue
colorOrientation
colorPosition
colorValue
puckPosition
reset
saturationValue

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

brightness
colorWell
doNudgeColor
doSelect
doShow
nudgeColor
saturation
select
show

#API Documentation

#Constants

#TYPE


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.TYPE`
Type	Constant
Description	The possible types of ColorWheels: MASTER, SHADOWS, MIDTONES, HIGHLIGHTS.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 23

#Functions

#matches


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

#Constructors

#ColorWheel


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel(parent, type) -> ColorWheel`
Type	Constructor
Description	Creates a new `ColorWheel` instance, with the specified parent and type.
Parameters	parent - The parent object. type - The type of color wheel. Must be one of the `ColorWheel.TYPE` values.
Returns	A new `ColorWheel` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 55

#Fields

#brightnessValue


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.brightnessValue <cp.prop: number>`
Type	Field
Description	The current brightness value, as a number between -12 and 10.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 135

#colorOrientation


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.colorOrientation <cp.prop: table>`
Type	Field
Description	Provides the orientation of the color as a table containing an `up` and `right` value.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 120

#colorPosition


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.colorPosition <cp.prop: point>`
Type	Field
Description	X/Y screen position for the current color value of the Color Well. This ignores the bounds of the
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 112

#colorValue


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.colorValue <cp.prop: hs.drawing.color>`
Type	Field
Description	The current color value, as a `hs.drawing.color` table.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 98

#puckPosition


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.puckPosition <cp.prop: point>`
Type	Field
Description	Absolute X/Y screen position for the puck in the Color Well. Colours outside the bounds are clamped inside the color well.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 105

#reset


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.reset <cp.ui.Button>`
Type	Field
Description	A Button that resets the color wheel values, if the `ColorWheel` is showing.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 275

#saturationValue


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.saturationValue <cp.prop: number>`
Type	Field
Description	The current saturation value, as a number between 0 and 10.
Notes	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 128

#Methods

#brightness


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.brightness <ValueIndicator>`
Type	Method
Description	Returns the brightness `ValueIndicator` for this ColorWheel.
Parameters	None
Returns	The brightness `ValueIndicator` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 251

#colorWell


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.colorWell <ColorWell>`
Type	Method
Description	Returns the `ColorWell` for this ColorWheel.
Parameters	None
Returns	The `ColorWell` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 212

#doNudgeColor


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:doNudgeColor(right, up) -> cp.rx.go.Statement`
Type	Method
Description	A Statement that nudges the `colorPosition` by `right`/`up` values. Negative `right` values shift left, negative `up` values shift down. You may have decimal shift values.
Parameters	`right` - The number of steps to shift right. May be negative to shift left. `up` - The number of pixels to shift down. May be negative to shift down.
Returns	The `Statement`, resolving to `true` if successful.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 300

#doSelect


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:doSelect() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that attempts to select this `ColorWheel`.
Parameters	None
Returns	The `Statement`, resolving to `true` if selected, otherwise `false`.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 195

#doShow


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:doShow() -> cp.rx.go.Statement`
Type	Method
Description	A Statement that attempts to show the `ColorWheel`.
Parameters	None
Returns	The `Statement`, resolving to `true` if shown, `false` if not.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 161

#nudgeColor


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:nudgeColor(right, up) -> self`
Type	Method
Description	Nudges the `colorPosition` by `right`/`up` values. Negative `right` values shift left, negative `up` values shift down. You may have decimal shift values.
Parameters	`right` - The number of steps to shift right. May be negative to shift left. `up` - The number of pixels to shift down. May be negative to shift down.
Returns	The `ColorWheel` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 285

#saturation


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel.saturation <ValueIndicator>`
Type	Method
Description	Returns the saturation `ValueIndicator` for this ColorWheel.
Parameters	None
Returns	The saturation `ValueIndicator` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 227

#select


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:select() -> cp.apple.finalcutpro.inspector.color.ColorWheel`
Type	Method
Description	Shows and selects this color wheel.
Parameters	None
Returns	The `ColorWheel` instance.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 181

#show


Signature	`cp.apple.finalcutpro.inspector.color.ColorWheel:show() -> self`
Type	Method
Description	Shows the `ColorWheel`, if possible.
Parameters	None
Returns	The same `ColorWheel` instance, for chaining.
Notes	None
Examples	None
Source	src/extensions/cp/apple/finalcutpro/inspector/color/ColorWheel.lua line 142