docs » cp.apple.finalcutpro.inspector.color.ColorBoardAspect
Represents a particular aspect of the color board (Color/Saturation/Exposure).
- Constants - Useful values which cannot be changed
- ids
- Constructors - API calls which return an object, typically one that offers API methods
- ColorBoardAspect
- Fields - Variables which can only be accessed from an object returned by a constructor
- highlights
- master
- midtones
- selected
- shadows
- Methods - API calls which can only be made on an object returned by a constructor
- doShow
- hasAngle
- id
- index
- reset
- show
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect.ids -> table |
---|---|
Type | Constant |
Description | A table containing the list of aspect IDs ("color", "saturation", "exposure"). |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect(parent, index[, hasAngle]) -> ColorBoardAspect |
---|---|
Type | Constructor |
Description | Creates a new ColorBoardAspect object. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect.highlights <ColorPuck> |
---|---|
Type | Field |
Description | The Highlights ColorPuck object. |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect.master <ColorPuck> |
---|---|
Type | Field |
Description | The Master ColorPuck object. |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect.midtones <ColorPuck> |
---|---|
Type | Field |
Description | The Midtones ColorPuck object. |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:selected() -> boolean |
---|---|
Type | Field |
Description | Is the Color Board Aspect selected? |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect.shadows <ColorPuck> |
---|---|
Type | Field |
Description | The Shadows ColorPuck object. |
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:doShow() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that shows this Color Board Aspect. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:hasAngle() -> boolean |
---|---|
Type | Method |
Description | Checks if the aspect has an angle property. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:id() -> string |
---|---|
Type | Method |
Description | Gets the Color Board Aspect ID. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:index() -> number |
---|---|
Type | Method |
Description | Gets the Color Board Aspect index. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:reset() -> cp.rx.go.Statement |
---|---|
Type | Method |
Description | A Statement that resets all pucks in the the Color Board Aspect. |
Parameters |
|
Returns |
|
Signature | cp.apple.finalcutpro.inspector.color.ColorBoardAspect:show() -> cp.apple.finalcutpro.inspector.color.ColorBoardAspect |
---|---|
Type | Method |
Description | Shows the Color Board Aspect |
Parameters |
|
Returns |
|