github/InvokeAI
1
1
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI.git synced 2026-04-23 03:00:31 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(ui): update docstrings for startTransform

Browse Source
This commit is contained in:
psychedelicious
2024-10-16 09:25:16 +10:00
committed by Kent Keirsey
parent fc5f9047c2
commit 804ee3a7fb
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
invokeai/frontend/web/src/features/controlLayers/konva/CanvasEntity/CanvasEntityTransformer.ts
View File

@@ -653,9 +653,20 @@ export class CanvasEntityTransformer extends CanvasModuleBase {
/**
* Starts the transformation of the entity.
*
* This method will asynchronously acquire a mutex to prevent concurrent operations. If you need to perform an
* operation after the transformation is started, you should await this method.
*
* @param arg Options for starting the transformation
* @param arg.silent Whether the transformation should be silent. If silent, the transform controls will not be shown,
* so you _must_ immediately call `applyTransform` or `stopTransform` to complete the transformation.
* so you _must_ call `applyTransform` or `stopTransform` to complete the transformation.
*
* @example
* ```ts
* await adapter.transformer.startTransform({ silent: true });
* adapter.transformer.fitToBboxContain();
* await adapter.transformer.applyTransform();
* ```
*/
startTransform = async (arg?: { silent: boolean }) => {
const transformingAdapter = this.manager.stateApi.$transformingAdapter.get();