# cp.apple.finalcutpro.inspector.color.ColorWell

Represents a single Color Well in the Color Wheels Inspector.

# API Overview

Constants - Useful values which cannot be changed

  • KEY_PRESS

Functions - API calls offered directly by the extension

  • matches

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

  • ColorWell

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

  • center
  • colorOrientation
  • colorPosition
  • focused
  • puckPosition

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

  • nudge
  • reset
  • select

# API Documentation

# Constants

# KEY_PRESS

Signature cp.apple.finalcutpro.inspector.color.ColorWell.KEY_PRESS
Type Constant
Description This can be used with nudge to shift by the same distance
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 30

# Functions

# matches

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

# Constructors

# ColorWell

Signature cp.apple.finalcutpro.inspector.color.ColorWell(parent, uiFinder[, hueShift]) -> ColorWell
Type Constructor
Description Creates a new ColorWell instance, with the specified parent and finder function. The finder function should return the specific color well UI element that this instance represents.
Parameters
  • parent - The parent object
  • uiFinder - Returns the axuielement that represents the color well.
  • hueShift - The amount to shift the hue.
Returns
  • A new ColorWell instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 259

# Fields

# center

Signature cp.apple.finalcutpro.inspector.color.ColorWell.center <cp.prop: point; read-only>
Type Field
Description The center point of the ColorWell. A table with {x=..., y=...}.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 304

# colorOrientation

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

# colorPosition

Signature cp.apple.finalcutpro.inspector.color.ColorWell.colorPosition <cp.prop: hs.geometry.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/ColorWell.lua line 334

# focused

Signature cp.apple.finalcutpro.inspector.color.ColorWell.focused <cp.pref: boolean>
Type Field
Description Gets and sets whether the Color Well has focus.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 279

# puckPosition

Signature cp.apple.finalcutpro.inspector.color.ColorWell.puckPosition <cp.prop: hs.geometry.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/ColorWell.lua line 313

# Methods

# nudge

Signature cp.apple.finalcutpro.inspector.color.ColorWell:nudge(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 ColorWell instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 428

# reset

Signature cp.apple.finalcutpro.inspector.color.ColorWell:reset() -> self
Type Method
Description Resets the color wheel.
Parameters
  • None
Returns
  • The ColorWell instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 444

# select

Signature cp.apple.finalcutpro.inspector.color.ColorWell:select() -> cp.apple.finalcutpro.inspector.color.ColorWell
Type Method
Description Selects this color well.
Parameters
  • None
Returns
  • The ColorWell instance.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 389

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