cp.apple.finalcutpro.inspector.color.ColorWheel.md

docs » 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
• focused
• 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.

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.

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.

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.

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.

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

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.

focused

Signature	cp.apple.finalcutpro.inspector.color.ColorWheel.focused <cp.pref: boolean>
Type	Field
Description	Gets and sets whether the Color Well has focus.

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.

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.

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.

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.

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.

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.
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.

doSelect

Signature	cp.apple.finalcutpro.inspector.color.ColorWheel:doSelect() -> cp.rx.go.Statement
Type	Method
Description	A Statement that attempts to select this ColorWheel.
Returns	The Statement, resolving to true if selected, otherwise false.

doShow

Signature	cp.apple.finalcutpro.inspector.color.ColorWheel:doShow() -> cp.rx.go.Statement
Type	Method
Description	A Statement that attempts to show the ColorWheel.
Returns	The Statement, resolving to true if shown, false if not.

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,
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.

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.

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.

show

Signature	cp.apple.finalcutpro.inspector.color.ColorWheel:show() -> self
Type	Method
Description	Shows the ColorWheel, if possible.
Returns	The same ColorWheel instance, for chaining.