# cp.apple.finalcutpro.inspector.color.ColorPuck Color ColorPuck Module. --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [DEFAULT_ANGLES](#default_angles) * [ELASTICITY](#elasticity) * [NATURAL_LENGTH](#natural_length) * [RANGE](#range) **Functions** - _API calls offered directly by the extension_ * [matches](#matches) **Constructors** - _API calls which return an object, typically one that offers API methods_ * [ColorPuck](#colorpuck) **Fields** - _Variables which can only be accessed from an object returned by a constructor_ * [angle](#angle) * [label](#label) * [percent](#percent) * [row](#row) * [skimming](#skimming) **Methods** - _API calls which can only be made on an object returned by a constructor_ * [accumulate](#accumulate) * [cleanup](#cleanup) * [colorMarker](#colormarker) * [contentUI](#contentui) * [doReset](#doreset) * [doSelect](#doselect) * [doShiftPercent](#doshiftpercent) * [doShow](#doshow) * [drawMarker](#drawmarker) * [getArc](#getarc) * [getBrightness](#getbrightness) * [hasAngle](#hasangle) * [index](#index) * [loop](#loop) * [reset](#reset) * [select](#select) * [shiftAngle](#shiftangle) * [shiftPercent](#shiftpercent) * [show](#show) * [start](#start) * [stop](#stop) --- ## API Documentation #### Constants ### [DEFAULT_ANGLES](#default_angles) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.DEFAULT_ANGLES -> table` | | **Type** | Constant | | **Description** | The table of default angles for the various pucks (1-4). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 47](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L47) | --- ### [ELASTICITY](#elasticity) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.ELASTICITY -> number` | | **Type** | Constant | | **Description** | Elasticity as number. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 42](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L42) | --- ### [NATURAL_LENGTH](#natural_length) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.NATURAL_LENGTH -> number` | | **Type** | Constant | | **Description** | Natural Length as number. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 37](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L37) | --- ### [RANGE](#range) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.RANGE -> table` | | **Type** | Constant | | **Description** | Table of puck ranges. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 32](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L32) | --- #### Functions ### [matches](#matches) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.matches(element) -> boolean` | | **Type** | Function | | **Description** | Checks to see if an element matches what we think it should be. | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 77](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L77) | --- #### Constructors ### [ColorPuck](#colorpuck) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck(parent, puckNumber, labelKeys, hasAngle) -> ColorPuck` | | **Type** | Constructor | | **Description** | Creates a new `ColorPuck` object | | **Parameters** | | | **Returns** | | | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 90](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L90) | --- #### Fields ### [angle](#angle) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.angle ` | | **Type** | Field | | **Description** | The 'angle' text field (only present for the 'color' aspect). | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 172](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L172) | --- ### [label](#label) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.label ` | | **Type** | Field | | **Description** | The human-readable label for the puck, in FCPX's current language. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 155](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L155) | --- ### [percent](#percent) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.percent ` | | **Type** | Field | | **Description** | The 'percent' text field. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 162](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L162) | --- ### [row](#row) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.row ` | | **Type** | Field | | **Description** | Finds the 'row' for the property type. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 148](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L148) | --- ### [skimming](#skimming) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck.skimming ` | | **Type** | Field | | **Description** | The Skimming Preferences value. | | **Notes** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 141](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L141) | --- #### Methods ### [accumulate](#accumulate) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:accumulate(xShift, yShift) -> none` | | **Type** | Method | | **Description** | Accumulate's the Shift Values. | | **Parameters** |
  • `xShift` - `x` value as number
  • `yShift` - `y` value as number
| | **Returns** |
  • `x` - Accumulated `x` value as number
  • `y` - Accumulated `y` value as number
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 582](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L582) | --- ### [cleanup](#cleanup) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:cleanup() -> none` | | **Type** | Method | | **Description** | Cleans up the Color ColorPuck drawings. | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 551](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L551) | --- ### [colorMarker](#colormarker) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:colorMarker(pct, angle) -> none` | | **Type** | Method | | **Description** | Draws a Color Marker. | | **Parameters** |
  • pct - Percentage
  • angle - Angle
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 499](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L499) | --- ### [contentUI](#contentui) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:contentUI() -> axuielementObject` | | **Type** | Method | | **Description** | Returns the Content Accessibility Object | | **Parameters** |
  • None
| | **Returns** |
  • An `axuielementObject` or `nil`
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 128](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L128) | --- ### [doReset](#doreset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:doReset() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that resets the puck to its default settings. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, resolving to `true` if successful, or throwing an error if not.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 358](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L358) | --- ### [doSelect](#doselect) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:doSelect() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that selects this puck. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, resolving to `true` if successful or throwing an error if no.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 260](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L260) | --- ### [doShiftPercent](#doshiftpercent) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:doShiftPercent(amount) -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that shifts the percent value by the provide amount. | | **Parameters** |
  • `amount` - The amount to shift the percent value.
| | **Returns** |
  • The `Statement`, resolving to the updated percent value, or throwing an error if there is a problem.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 301](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L301) | --- ### [doShow](#doshow) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:doShow() -> cp.rx.go.Statement` | | **Type** | Method | | **Description** | A [Statement](cp.rx.go.Statement.md) that shows the Color ColorPuck. | | **Parameters** |
  • None
| | **Returns** |
  • The `Statement`, resolving to `true` if successful or sending an error if not.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 226](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L226) | --- ### [drawMarker](#drawmarker) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:drawMarker() -> none` | | **Type** | Method | | **Description** | Draws a marker. | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 464](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L464) | --- ### [getArc](#getarc) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:getArc() -> number` | | **Type** | Method | | **Description** | Gets the arc value. | | **Parameters** |
  • None
| | **Returns** |
  • The arc value as number.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 445](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L445) | --- ### [getBrightness](#getbrightness) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:getBrightness() -> number` | | **Type** | Method | | **Description** | Gets the brightness value. | | **Parameters** |
  • None
| | **Returns** |
  • The brightness value as number.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 422](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L422) | --- ### [hasAngle](#hasangle) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:hasAngle() -> boolean` | | **Type** | Method | | **Description** | Indicates if the puck has an `angle` parameter. The `angle` `cp.prop` will always exist regardless, but if this is `false`, it will never return a result. | | **Parameters** |
  • None
| | **Returns** |
  • `true` if the puck has an `angle`.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 199](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L199) | --- ### [index](#index) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:index() -> number` | | **Type** | Method | | **Description** | Returns the puck number (1 through 4). | | **Parameters** |
  • None
| | **Returns** |
  • The puck number.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 186](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L186) | --- ### [loop](#loop) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:loop() -> none` | | **Type** | Method | | **Description** | Loops the Color ColorPuck function. | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 615](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L615) | --- ### [reset](#reset) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:reset() -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Resets the puck to its default settings. | | **Parameters** |
  • None
| | **Returns** |
  • The `ColorPuck` instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 343](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L343) | --- ### [select](#select) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:select() -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Selects this puck. | | **Parameters** |
  • None
| | **Returns** |
  • The `ColorPuck` instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 239](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L239) | --- ### [shiftAngle](#shiftangle) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:shiftAngle(amount) -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Shifts the angle value by the provide amount. | | **Parameters** |
  • amount - The amount to shift the angle value.
| | **Returns** |
  • The `ColorPuck` instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 318](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L318) | --- ### [shiftPercent](#shiftpercent) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:shiftPercent(amount) -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Shifts the percent value by the provide amount. | | **Parameters** |
  • `amount` - The amount to shift the percent value.
| | **Returns** |
  • The updated value.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 284](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L284) | --- ### [show](#show) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:show() -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Shows the Color ColorPuck | | **Parameters** |
  • None
| | **Returns** |
  • The `cp.apple.finalcutpro.inspector.color.ColorPuck` object for method chaining.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 212](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L212) | --- ### [start](#start) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:start() -> cp.apple.finalcutpro.inspector.color.ColorPuck` | | **Type** | Method | | **Description** | Starts a Color ColorPuck. | | **Parameters** |
  • None
| | **Returns** |
  • The `ColorPuck` instance.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 375](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L375) | --- ### [stop](#stop) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `cp.apple.finalcutpro.inspector.color.ColorPuck:stop() -> none` | | **Type** | Method | | **Description** | Stops a Color ColorPuck. | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua line 538](https://github.com/CommandPost/CommandPost/blob/develop/src/extensions/cp/apple/finalcutpro/inspector/color/ColorPuck.lua#L538) | --- ---