Configure Transforms

PhotoEditor SDK supports several configuration options for the TransformToolPanel allowing flexible adaptation to different needs and use cases.

Forcing specific ratios#

The default configuration includes several different crop aspect ratios users can choose from. To restrict those to specific aspect ratios only, for instance, those used by social networks (e.g. Facebook, Twitter, Instagram, Flickr), we can specify aspect ratios as CropAspectAssets and give it the desired width and height.

For the UI, we add CropAspectItems with ids matching CropAspectAssets. The CropAspectItem constructor allows using a custom name and ImageSource for further customization.

For the sake of this example, we don't add the Reset button and Free Crop since we are enforcing certain ratios.

Force crop#

PhotoEditor SDK chooses the best matching aspect amongst the specified ratios for the input photo. However, you can also force a specific ratio.

Here, we force the 16:9 ratio for landscape photos and the 9:16 ratio for portrait photos. However, the user can still choose from one of the specified ratios above using the TransformTool.

We also set the forceCropMode to SHOW_TOOL_ALWAYS. This ensures that the transform tool is always presented first before being able to use other features of the editor.


class PhotoTransform(private val activity: AppCompatActivity) : Example(activity) {

    override fun invoke() {
        // In this example, we do not need access to the Uri(s) after the editor is closed
        // so we pass false in the constructor
        val settingsList = PhotoEditorSettingsList(false)
            // Set the source as the Uri of the image to be loaded
            .configure<LoadSettings> {
                it.source = activity.resourceUri(R.drawable.la)
            }

        // By default the editor has a lot of crop aspects enabled.
        // For this example only a couple are enabled, e.g. if you
        // only allow certain image aspects in your application.
        // Add crop aspect assets to the backend
        settingsList.config.getAssetMap(CropAspectAsset::class.java).clear().add(
            // For this example, free crop is not added to ensure that the image has a suitable ratio.
            // CropAspectAsset.FREE_CROP,
            CropAspectAsset("my_crop_1_1", 1, 1, false),
            CropAspectAsset("my_crop_16_9", 16, 9, false),
            CropAspectAsset("my_crop_9_16", 9, 16, false)
        )

        // Add crop aspect items to the UI
        // Make sure that the corresponding CropAspectAsset ID exists in the backend
        settingsList.configure<UiConfigAspect> {
            it.setAspectList(
                // In this example, we don't add the Reset button and Free Crop since we are enforcing certain ratios
                // and the user can only select among them anyway.
                // CropResetItem(),
                // CropAspectItem(
                //     FREE_CROP_ID, ly.img.android.pesdk.ui.transform.R.string.pesdk_transform_button_freeCrop,
                //     ImageSource.create(ly.img.android.pesdk.ui.transform.R.drawable.imgly_icon_custom_crop)
                // ),
                CropAspectItem("my_crop_1_1"),
                CropAspectItem("my_crop_16_9"),
                CropAspectItem("my_crop_9_16")
            )
        }

        settingsList.configure<TransformSettings> {
            // The backend automatically forces one of the specified crop ratios
            // that best matches the input photo. However, you can also force a specific crop ratio.
            it.setForceCrop("my_crop_16_9", "my_crop_9_16")
        }.configure<UiConfigAspect> {
            // This ensures that the transform tool is always presented first
            // before being able to use other features of the editor.
            it.forceCropMode = UiConfigAspect.ForceCrop.SHOW_TOOL_ALWAYS
        }

        // Start the photo editor using PhotoEditorBuilder
        // The result will be obtained in onActivityResult() corresponding to EDITOR_REQUEST_CODE
        PhotoEditorBuilder(activity)
            .setSettingsList(settingsList)
            .startActivityForResult(activity, EDITOR_REQUEST_CODE)

        // Release the SettingsList once done
        settingsList.release()
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {
        intent ?: return
        if (requestCode == EDITOR_REQUEST_CODE) {
            // Wrap the intent into an EditorSDKResult
            val result = EditorSDKResult(intent)
            when (result.resultStatus) {
                EditorSDKResult.Status.CANCELED -> showMessage("Editor cancelled")
                EditorSDKResult.Status.EXPORT_DONE -> showMessage("Result saved at ${result.resultUri}")
                else -> {
                }
            }
        }
    }
}