Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ui): konva image object docstrings

Browse Source
This commit is contained in:
psychedelicious 2024-06-06 18:43:08 +10:00
parent 99d8b3a7bf
commit ae7228d821
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
invokeai/frontend/web/src/features/controlLayers/konva/renderers/objects.ts
View File

@ -96,6 +96,11 @@ export const createRectShape = (rectShape: RectShape, layerObjectGroup: Konva.Gr
return konvaRect;
};
/**
* Creates an image placeholder group for an image object.
* @param imageObject The image object state
* @returns The konva group for the image placeholder, and callbacks to handle loading and error states
*/
const createImagePlaceholderGroup = (
imageObject: ImageObject
): { konvaPlaceholderGroup: Konva.Group; onError: () => void; onLoading: () => void; onLoaded: () => void } => {
@ -134,6 +139,14 @@ const createImagePlaceholderGroup = (
return { konvaPlaceholderGroup, onError, onLoading, onLoaded };
};
/**
* Creates an image object group. Because images are loaded asynchronously, and we need to handle loading an error state,
* the image is rendered in a group, which includes a placeholder.
* @param imageObject The image object state
* @param layerObjectGroup The konva layer's object group to add the image to
* @param name The konva name for the image
* @returns A promise that resolves to the konva group for the image object
*/
export const createImageObjectGroup = async (
imageObject: ImageObject,
layerObjectGroup: Konva.Group,