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

Color Inspector Module.

#API Overview

Constants - Useful values which cannot be changed

Functions - API calls offered directly by the extension

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

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

#API Documentation

#Constants

Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.CORRECTION_TYPES
TypeConstant
DescriptionTable 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)
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/CorrectionsBar.lua line 28

#Functions

Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.matches(element)
TypeFunction
DescriptionChecks if the specified element is the Color Inspector element.
Parameters
  • element - The element to check
Returns
  • true if the element is the Color Inspector.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 29

#Fields

Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.colorAdjustments <ColorAdjustments>
TypeField
DescriptionThe ColorAdjustments object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 286
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.colorBoard <ColorBoard>
TypeField
DescriptionThe ColorBoard object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 234
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.colorCurves <ColorCurves>
TypeField
DescriptionThe ColorCurves object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 260
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.colorWheels <ColorWheels>
TypeField
DescriptionThe ColorWheels object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 247
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.corrections <CorrectionsBar>
TypeField
DescriptionThe CorrectionsBar instance representing the available corrections,
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 106
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.correctorUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the hs.axuielement object representing the currently-selected corrector panel.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 82
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.hueSaturationCurves <HueSaturationCurves>
TypeField
DescriptionThe HueSaturationCurves object.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 273
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.topBarUI <cp.prop: hs.axuielement; read-only>
TypeField
DescriptionReturns the hs.axuielement object representing the top bar.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 63
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector.value <cp.prop: cp.drawing.color>
TypeField
DescriptionGets the Color Well Value as a cp.drawing.color.
NotesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorWell.lua line 286

#Methods

Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:activateCorrection(correctionType[, number]) -> self
TypeMethod
DescriptionActivates 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
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 154
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:addCorrection(correctionType) -> self
TypeMethod
DescriptionAdds 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
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 184
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector(parent) -> ColorInspector object
TypeMethod
DescriptionCreates a new ColorInspector object
Parameters
  • parent - The parent
Returns
  • A ColorInspector object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 50
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:doActivateCorrection(correctionType[, number]) -> cp.rx.go.Statement<boolean>
TypeMethod
DescriptionReturns 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 169
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:doAddCorrection(correctionType) -> cp.rx.go.Statement
TypeMethod
DescriptionA 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.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 198
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:doShow() -> cp.rx.go.Statement
TypeMethod
DescriptionA Statement that attempts to show the Color Inspector.
Parameters
  • None
Returns
  • The Statement, resolving to true if successful or sending an error if not.
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 136
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:hide() -> ColorInspector
TypeMethod
DescriptionHides the Color Inspector
Parameters
  • None
Returns
  • ColorInspector object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 212
Signaturecp.apple.finalcutpro.inspector.color.ColorInspector:show() -> self
TypeMethod
DescriptionShows the Color Inspector.
Parameters
  • None
Returns
  • ColorInspector object
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/apple/finalcutpro/inspector/color/ColorInspector.lua line 120

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