# cp.apple.finalcutpro.inspector.color.ColorInspector

Color Inspector Module.

# API Overview

Constants - Useful values which cannot be changed

  • CORRECTION_TYPES

Functions - API calls offered directly by the extension

  • matches

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

  • colorAdjustments
  • colorBoard
  • colorCurves
  • colorWheels
  • corrections
  • correctorUI
  • hueSaturationCurves
  • topBarUI
  • value

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

  • activateCorrection
  • addCorrection
  • ColorInspector
  • doActivateCorrection
  • doAddCorrection
  • doShow
  • hide
  • show

# API Documentation

# Constants

# CORRECTION_TYPES

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.CORRECTION_TYPES
Type Constant
Description Table of Correction Types.
Notes
  • Possible values are:
  • ** "Color Board"
  • ** "Color Wheels"
  • ** "Color Curves"
  • ** "Hue/Saturation Curves"
  • ** "Color Adjustments" (Final Cut Pro 10.6.6 or later)
Source src/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 28

# Functions

# matches

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

# Fields

# colorAdjustments

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.colorAdjustments <ColorAdjustments>
Type Field
Description The ColorAdjustments object.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 286

# colorBoard

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.colorBoard <ColorBoard>
Type Field
Description The ColorBoard object.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 234

# colorCurves

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.colorCurves <ColorCurves>
Type Field
Description The ColorCurves object.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 260

# colorWheels

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.colorWheels <ColorWheels>
Type Field
Description The ColorWheels object.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 247

# corrections

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.corrections <CorrectionsBar>
Type Field
Description The CorrectionsBar instance representing the available corrections,
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 106

# correctorUI

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.correctorUI <cp.prop: hs.axuielement; read-only>
Type Field
Description Returns the hs.axuielement object representing the currently-selected corrector panel.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 82

# hueSaturationCurves

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.hueSaturationCurves <HueSaturationCurves>
Type Field
Description The HueSaturationCurves object.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 273

# topBarUI

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.topBarUI <cp.prop: hs.axuielement; read-only>
Type Field
Description Returns the hs.axuielement object representing the top bar.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 63

# value

Signature cp.apple.finalcutpro.inspector.color.ColorInspector.value <cp.prop: cp.drawing.color>
Type Field
Description Gets the Color Well Value as a cp.drawing.color.
Notes None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 286

# Methods

# activateCorrection

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:activateCorrection(correctionType[, number]) -> self
Type Method
Description Activates the named correction type and number, if present. If no corrector with the type/number combination exists, a new one is added.
Parameters
  • correctionType - The string for the type of correction (in English). E.g. "Color Wheels", "Color Board", etc.
  • number - The correction number for that type. Defaults to 1.
Returns
  • ColorInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 154

# addCorrection

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:addCorrection(correctionType) -> self
Type Method
Description Adds the named correction type.
Parameters
  • correctionType - The string for the type of correction (in English). E.g. "Color Wheels", "Color Board", etc.
Returns
  • ColorInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 184

# ColorInspector

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

# doActivateCorrection

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:doActivateCorrection(correctionType[, number]) -> cp.rx.go.Statement<boolean>
Type Method
Description Returns a Statement that activates the named correction type and number, if present. If no corrector with the type/number combination exists, a new one is added.
Parameters
  • correctionType - The string for the type of correction (in English). E.g. "Color Wheels", "Color Board", etc.
  • number - The correction number for that type. Defaults to 1.
Returns
  • The Statement, which sends a single true value if successful, or sends an error if not.
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 169

# doAddCorrection

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:doAddCorrection(correctionType) -> cp.rx.go.Statement
Type Method
Description A Statement that adds the named correction type.
Parameters
  • correctionType - The string for the type of correction (in English). E.g. "Color Wheels", "Color Board", etc.
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/ColorInspector.lua line 198

# doShow

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:doShow() -> cp.rx.go.Statement
Type Method
Description A Statement that attempts to show the Color Inspector.
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/ColorInspector.lua line 136

# hide

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:hide() -> ColorInspector
Type Method
Description Hides the Color Inspector
Parameters
  • None
Returns
  • ColorInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 212

# show

Signature cp.apple.finalcutpro.inspector.color.ColorInspector:show() -> self
Type Method
Description Shows the Color Inspector.
Parameters
  • None
Returns
  • ColorInspector object
Notes None
Examples None
Source src/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 120

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