docs » cp.apple.finalcutpro.inspector.color.ColorPuck
Color ColorPuck Module.
- Constants - Useful values which cannot be changed
- DEFAULT_ANGLES
- ELASTICITY
- NATURAL_LENGTH
- RANGE
- Functions - API calls offered directly by the extension
- matches
- Constructors - API calls which return an object, typically one that offers API methods
- ColorPuck
- Fields - Variables which can only be accessed from an object returned by a constructor
- angle
- label
- percent
- row
- skimming
- Methods - API calls which can only be made on an object returned by a constructor
- accumulate
- cleanup
- colorMarker
- contentUI
- doReset
- doSelect
- doShiftPercent
- doShow
- drawMarker
- getArc
- getBrightness
- hasAngle
- index
- loop
- reset
- select
- shiftAngle
- shiftPercent
- show
- start
- stop
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.DEFAULT_ANGLES -> table |
---|---|
Type | Constant |
Description | The table of default angles for the various pucks (1-4). |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.ELASTICITY -> number |
---|---|
Type | Constant |
Description | Elasticity as number. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.NATURAL_LENGTH -> number |
---|---|
Type | Constant |
Description | Natural Length as number. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.RANGE -> table |
---|---|
Type | Constant |
Description | Table of puck ranges. |
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 |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck(parent, puckNumber, labelKeys, hasAngle) -> ColorPuck |
---|---|
Type | Constructor |
Description | Creates a new ColorPuck object |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.angle <cp.ui.TextField> |
---|---|
Type | Field |
Description | The 'angle' text field (only present for the 'color' aspect). |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.label <cp.prop: string; read-only> |
---|---|
Type | Field |
Description | The human-readable label for the puck, in FCPX's current language. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.percent <cp.prop: TextField> |
---|---|
Type | Field |
Description | The 'percent' text field. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.row <cp.prop: PropertyRow> |
---|---|
Type | Field |
Description | Finds the 'row' for the property type. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck.skimming <cp.prop: boolean> |
---|---|
Type | Field |
Description | The Skimming Preferences value. |
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:accumulate() -> none |
---|---|
Type | Method |
Description | Accumulate's the Shift Values. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:cleanup() -> none |
---|---|
Type | Method |
Description | Cleans up the Color ColorPuck drawings. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:colorMarker(pct, angle) -> none |
---|---|
Type | Method |
Description | Draws a Color Marker. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:contentUI() -> axuielementObject |
---|---|
Type | Method |
Description | Returns the Content Accessibility Object |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:doReset() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that resets the puck to its default settings. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:doSelect() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that selects this puck. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:doShiftPercent(amount) -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that shifts the percent value by the provide amount. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:doShow() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that shows the Color ColorPuck. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:drawMarker() -> none |
---|---|
Type | Method |
Description | Draws a marker. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:getArc() -> number |
---|---|
Type | Method |
Description | Gets the arc value. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:getBrightness() -> number |
---|---|
Type | Method |
Description | Gets the brightness value. |
Parameters |
|
Returns |
|
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 |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:index() -> number |
---|---|
Type | Method |
Description | Returns the puck number (1 through 4). |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:loop() -> none |
---|---|
Type | Method |
Description | Loops the Color ColorPuck function. |
Parameters |
|
Returns |
|
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 |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:select() -> cp.apple.finalcutpro.inspector.color.ColorPuck |
---|---|
Type | Method |
Description | Selects this puck. |
Parameters |
|
Returns |
|
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 |
|
Returns |
|
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 |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:show() -> cp.apple.finalcutpro.inspector.color.ColorPuck |
---|---|
Type | Method |
Description | Shows the Color ColorPuck |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:start() -> cp.apple.finalcutpro.inspector.color.ColorPuck |
---|---|
Type | Method |
Description | Starts a Color ColorPuck. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorPuck:stop() -> none |
---|---|
Type | Method |
Description | Stops a Color ColorPuck. |
Parameters |
|
Returns |
|