Namespace LrDevelopController

 Parameters in panels: (these panel IDs can be used with revealPanel)
 
 adjustPanel = {
 "Temperature",
 "Tint",
 "Exposure",
 "Highlights", 	(controls Recovery in Version 1 and Version 2)
 "Shadows", 	(controls Fill Light in Version 1 and Version 2)
 "Brightness", (no effect unless in Version 1 or Version 2)
 "Contrast",
 "Whites", 	(no effect in Version 1 and Version 2)
 "Blacks",
 "Clarity",
 "Vibrance",
 "Saturation",
 }
 
 tonePanel = {
 "ParametricDarks",
 "ParametricLights",
 "ParametricShadows",
 "ParametricHighlights",
 "ParametricShadowSplit",
 "ParametricMidtoneSplit",
 "ParametricHighlightSplit",
 }
 
 mixerPanel = {
 -- HSL / Color
 "SaturationAdjustmentRed",
 "SaturationAdjustmentOrange",
 "SaturationAdjustmentYellow",
 "SaturationAdjustmentGreen",
 "SaturationAdjustmentAqua",
 "SaturationAdjustmentBlue",
 "SaturationAdjustmentPurple",
 "SaturationAdjustmentMagenta",
 "HueAdjustmentRed",
 "HueAdjustmentOrange",
 "HueAdjustmentYellow",
 "HueAdjustmentGreen",
 "HueAdjustmentAqua",
 "HueAdjustmentBlue",
 "HueAdjustmentPurple",
 "HueAdjustmentMagenta",
 "LuminanceAdjustmentRed",
 "LuminanceAdjustmentOrange",
 "LuminanceAdjustmentYellow",
 "LuminanceAdjustmentGreen",
 "LuminanceAdjustmentAqua",
 "LuminanceAdjustmentBlue",
 "LuminanceAdjustmentPurple",
 "LuminanceAdjustmentMagenta",
 -- B & W
 "GrayMixerRed",
 "GrayMixerOrange",
 "GrayMixerYellow",
 "GrayMixerGreen",
 "GrayMixerAqua",
 "GrayMixerBlue",
 "GrayMixerPurple",
 "GrayMixerMagenta",
 }
 
 splitToningPanel = {
 "SplitToningShadowHue",
 "SplitToningShadowSaturation",
 "SplitToningHighlightHue",
 "SplitToningHighlightSaturation",
 "SplitToningBalance",
 }
 
 detailPanel = {
 "Sharpness",
 "SharpenRadius",
 "SharpenDetail",
 "SharpenEdgeMasking",
 "LuminanceSmoothing",
 "LuminanceNoiseReductionDetail",
 "LuminanceNoiseReductionContrast",
 "ColorNoiseReduction",
 "ColorNoiseReductionDetail",
 "ColorNoiseReductionSmoothness",
 }
 
 effectsPanel = {
 -- Dehaze
 "Dehaze",
 -- Post-Crop Vignetting
 "PostCropVignetteAmount",
 "PostCropVignetteMidpoint",
 "PostCropVignetteFeather",
 "PostCropVignetteRoundness",
 "PostCropVignetteStyle",
 "PostCropVignetteHighlightContrast",
 -- Grain
 "GrainAmount",
 "GrainSize",
 "GrainFrequency",
 }
 
 lensCorrectionsPanel = {
 -- Profile
 "LensProfileDistortionScale",
 "LensProfileChromaticAberrationScale",
 "LensProfileVignettingScale",
 "LensManualDistortionAmount",
 -- Color
 "DefringePurpleAmount",
 "DefringePurpleHueLo",
 "DefringePurpleHueHi",
 "DefringeGreenAmount",
 "DefringeGreenHueLo",
 "DefringeGreenHueHi",
 -- Manual Perspective
 "PerspectiveVertical",
 "PerspectiveHorizontal",
 "PerspectiveRotate",
 "PerspectiveScale",
 "PerspectiveAspect",
 "PerspectiveX",
 "PerspectiveY",
 "PerspectiveUpright",
 }
 
 calibratePanel = {
 "ShadowTint",
 "RedHue",
 "RedSaturation",
 "GreenHue",
 "GreenSaturation",
 "BlueHue",
 "BlueSaturation",
 }
 
 Crop Angle:
 
 "straightenAngle"
 
 Localized Adjustments:
 
 Version 2:
 "local_ToningLuminance"
 "local_Exposure"
 "local_Contrast"
 "local_Clarity"
 "local_Saturation"
 "local_Sharpness"
 Version 3:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 Version 4:
 "local_Temperature"
 "local_Tint"
 "local_Exposure"
 "local_Contrast"
 "local_Highlights"
 "local_Shadows"
 "local_Clarity"
 "local_Saturation"
 "local_Sharpness"
 "local_LuminanceNoise"
 "local_Moire"
 "local_Defringe"
 "local_Blacks"
 "local_Whites"
 
 

Summary

Functions

LrDevelopController.addAdjustmentChangeObserver( functionContext, observer, callback )

Registers a callback to be called any time the adjustments in the Develop module change.

Must be called while the Develop module is active.

Do not show modal dialogs inside the callback.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. functionContext

(LrFunctionContext) The function context that retains the observation.

2. observer

(object) An object that uniquely identifies the observer. Will be passed into the callback.

3. callback

( function( observer ) ) Function that will be called.

LrDevelopController.decrement( param )

Increments the value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.editInPhotoshop()

Edit the current photo in Photoshop.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.getProcessVersion()

Returns the process version of the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.getRange( param )

Gets the min and max value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

Return value

(number, number) the min and max value for the given parameter.

LrDevelopController.getSelectedTool()

Reports which tool mode is active in Develop.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Return value

(string) current tool mode, one of: "loupe", "crop", "dust", "redeye", "gradient", "circularGradient", "localized".

LrDevelopController.getValue( param )

Gets the value of a Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.goToDevelopGraduatedFilter()

Opens Graduated Filter for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.goToDevelopRadialFilter()

Open Radial Filter for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.goToSpotRemoval()

Open Spot Removal for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.increment( param )

Increments the value of a Develop adjustment.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.resetAllDevelopAdjustments()

Resets all Develop adjustments for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetBrushing()

Clears all localized adjustment brushing from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetCircularGradient()

Clears all radial filter adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetCrop()

Resets the crop angle and frame for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetGradient()

Clears all graduated filter adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetRedeye()

Clears all redeye removal adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetSpotRemoval()

Clears all spot removal adjustments from the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.resetToDefault( param )

Resets a single Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.resetTransforms()

Clears all transforms from the current photo.

Must be called while the Develop module is active.

First supported in version 6.6 of the Lightroom SDK.

LrDevelopController.revealAdjustedControls( reveal )

Enables a mode where adjusting a parameter causes that panel to be automatically revealed in the panel track.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. reveal

(bool) true to enable reveal behavior, false to disable it (the default mode)

LrDevelopController.revealPanel( paramOrPanelID )

Expands and scrolls into view the panel with the given ID.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. paramOrPanelID

(string) either a Develop parameter or a panel ID (adjustPanel, tonePanel, mixerPanel, splitToningPanel, detailPanel, lensCorrectionsPanel, effectsPanel, or calibratePanel)

LrDevelopController.revealPanelIfVisible( paramOrPanelID )

Expands and scrolls into view the panel with the given ID only if the right panel is visible.

Must be called while the Develop module is active.

First supported in version 8.1 of the Lightroom SDK.

Parameters

1. paramOrPanelID

(string) either a Develop parameter or a panel ID (adjustPanel, tonePanel, mixerPanel, splitToningPanel, detailPanel, lensCorrectionsPanel, effectsPanel, or calibratePanel)

LrDevelopController.selectTool( tool )

Select a tool mode in Develop.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. tool

(string) new tool mode, one of: "loupe", "crop", "dust", "redeye", "gradient", "circularGradient", "localized", "upright".

LrDevelopController.setAutoTone()

Sets Auto Tone for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.setAutoWhiteBalance()

Sets Auto White Balance for the current photo.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.setMultipleAdjustmentThreshold( seconds )

Sets the time threshold that determines when adjustments to different parameters will be grouped together into a single history state versus recorded separately. If multiple different parameters are changed within a window of time that is less than this threshold, they will be grouped together into a single "Multiple Settings" history state. If they occur farther apart than this threshold, each will get its own history state. Recording many separate history states in rapid succession can degrade Lightroom's performance, so this threshold is very important if simultaneous adjustments by the user are a possibility. The default is 0.5 seconds. Has no effect if set to a value that is higher than the tracking delay.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. seconds

(number) time threshold under which multiple adjustments will be grouped together

LrDevelopController.setProcessVersion( value )

Sets the process version of the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. value

(string) the new process version, one of: "Version 1", "Version 2", "Version 3", "Version 4", or "Version 5".

LrDevelopController.setTrackingDelay( seconds )

Sets the number of seconds that tracking remains enabled after each adjustment is made. The default is 2 seconds.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. seconds

(number) number of seconds to wait before turning off tracking.

LrDevelopController.setValue( param, value )

Sets the value of a Develop adjustment for the current photo.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Temperature adjustment is logarithmic for RAW and DNG images, rest all are linear.

Texture is disabled for Process Versions 1 and 2. 3 and 4 will get auto updated to Current Process Version on changing.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

2. value

(number) the new value for the parameter

LrDevelopController.showClipping()

Shows the clipping.

Must be called while the Develop module is active.

First supported in version 7.4 of the Lightroom SDK.

LrDevelopController.startTracking( param )

Temporarily puts the Develop module into its tracking state, causing faster, lower-quailty redraw and preventing history states from being generated. Tracking will automatically be turned back off as soon as a diferent parameter is adjusted, or two seconds after the last adjustment is made.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

Parameters

1. param

(string) a Develop parameter name (see the beginning of this namespace's documentation for possible values).

LrDevelopController.stopTracking()

Causes Develop module to exit its tracking state immediately, creating a single history state for all changes that were made to the parameter that was being tracked.

Must be called while the Develop module is active.

First supported in version 6.0 of the Lightroom SDK.

LrDevelopController.toggleOverlay()

Toggles the mask overlay.

Must be called when any of the local adjustments filter is active.

First supported in version 7.4 of the Lightroom SDK.