@searpent/react-image-annotate 2.0.2 → 2.0.5

package/src/MainLayout/index.js

@@ -0,0 +1,510 @@
+// @flow
+
+import type { Action, MainLayoutState } from "./types"
+import { FullScreen, useFullScreenHandle } from "react-full-screen"
+import React, { useCallback, useRef } from "react"
+import { makeStyles } from "@mui/styles"
+import { createTheme, ThemeProvider } from "@mui/material/styles"
+import { styled } from "@mui/material/styles"
+import ClassSelectionMenu from "../ClassSelectionMenu"
+import DebugBox from "../DebugSidebarBox"
+import HistorySidebarBox from "../HistorySidebarBox"
+import ImageCanvas from "../ImageCanvas"
+import ImageSelector from "../ImageSelectorSidebarBox"
+import GroupSelector from "../GroupSelectorSidebarBox"
+import KeyframeTimeline from "../KeyframeTimeline"
+import KeyframesSelector from "../KeyframesSelectorSidebarBox"
+import type { Node } from "react"
+import RegionSelector from "../RegionSelectorSidebarBox"
+import SettingsDialog from "../SettingsDialog"
+import TagsSidebarBox from "../TagsSidebarBox"
+import TaskDescription from "../TaskDescriptionSidebarBox"
+import MetadataEditor from "../MetadataEditorSidebarBox"
+import Workspace from "react-material-workspace-layout/Workspace"
+import classnames from "classnames"
+import getActiveImage from "../Annotator/reducers/get-active-image"
+import getHotkeyHelpText from "../utils/get-hotkey-help-text"
+import iconDictionary from "./icon-dictionary"
+import styles from "./styles"
+import { useDispatchHotkeyHandlers } from "../ShortcutsManager"
+import useEventCallback from "use-event-callback"
+import useImpliedVideoRegions from "./use-implied-video-regions"
+import useKey from "use-key-hook"
+import { useSettings } from "../SettingsProvider"
+import { withHotKeys } from "react-hotkeys"
+import Editor from "../Editor"
+import regionsToBlocks from '../utils/regions-to-blocks';
+import PagesSelector from "../PageSelector"
+
+// import Fullscreen from "../Fullscreen"
+
+const emptyArr = []
+const theme = createTheme()
+const useStyles = makeStyles((theme) => styles)
+
+const HotkeyDiv = withHotKeys(({ hotKeys, children, divRef, ...props }) => (
+  <div {...{ ...hotKeys, ...props }} ref={divRef}>
+    {children}
+  </div>
+))
+
+const FullScreenContainer = styled("div")(({ theme }) => ({
+  width: "100%",
+  height: "100%",
+  "& .fullscreen": {
+    width: "100%",
+    height: "100%",
+  },
+}))
+
+const EditorWrapper = styled("div")(({ theme }) => ({
+  width: "45%",
+  padding: "1rem",
+  paddingLeft: "2rem"
+}))
+
+type Props = {
+  state: MainLayoutState,
+  RegionEditLabel?: Node,
+  dispatch: (Action) => any,
+  alwaysShowNextButton?: boolean,
+  alwaysShowPrevButton?: boolean,
+  onRegionClassAdded: () => {},
+  hideHeader?: boolean,
+  hideHeaderText?: boolean,
+  groups?: Array<any>,
+  onGroupSelect?: (any) => any,
+  hideHistory?: boolean,
+  hideNotEditingLabel?: boolean,
+  showEditor?: boolean,
+  showPageSelector?: boolean,
+  onRecalc?: (any) => any,
+  onSave?: (any) => any,
+  recalcActive?: boolean,
+  saveActive?: boolean,
+  allowedGroups?: boolean,
+  onMetadataChange: (any) => any
+}
+
+export const MainLayout = ({
+  state,
+  dispatch,
+  alwaysShowNextButton = false,
+  alwaysShowPrevButton = false,
+  RegionEditLabel,
+  onRegionClassAdded,
+  hideHeader,
+  hideHeaderText,
+  hideNext = false,
+  hidePrev = false,
+  hideClone = false,
+  hideSettings = false,
+  hideFullScreen = false,
+  hideSave = false,
+  groups = [],
+  onGroupSelect = () => { },
+  hideHistory = false,
+  hideNotEditingLabel = false,
+  showEditor = false,
+  showPageSelector = false,
+  onRecalc = () => { },
+  onSave = () => { },
+  recalcActive = false,
+  saveActive = false,
+  allowedGroups = {},
+  onMetadataChange
+}: Props) => {
+  const classes = useStyles()
+  const settings = useSettings()
+  const fullScreenHandle = useFullScreenHandle()
+
+  const memoizedActionFns = useRef({})
+  const action = (type: string, ...params: Array<string>) => {
+    const fnKey = `${type}(${params.join(",")})`
+    if (memoizedActionFns.current[fnKey])
+      return memoizedActionFns.current[fnKey]
+
+    const fn = (...args: any) =>
+      params.length > 0
+        ? dispatch(
+          ({
+            type,
+            ...params.reduce((acc, p, i) => ((acc[p] = args[i]), acc), {}),
+          }: any)
+          )
+        : dispatch({ type, ...args[0] })
+memoizedActionFns.current[fnKey] = fn
+return fn
+}
+
+const { currentImageIndex, activeImage } = getActiveImage(state)
+let nextImage
+if (currentImageIndex !== null) {
+  nextImage = state.images[currentImageIndex + 1]
+}
+
+useKey(() => dispatch({ type: "CANCEL" }), {
+  detectKeys: [27],
+})
+
+const isAVideoFrame = activeImage && activeImage.frameTime !== undefined
+const innerContainerRef = useRef()
+const hotkeyHandlers = useDispatchHotkeyHandlers({ dispatch })
+
+let impliedVideoRegions = useImpliedVideoRegions(state)
+
+const refocusOnMouseEvent = useCallback((e) => {
+  if (!innerContainerRef.current) return
+  if (innerContainerRef.current.contains(document.activeElement)) return
+  if (innerContainerRef.current.contains(e.target)) {
+    innerContainerRef.current.focus()
+    e.target.focus()
+  }
+}, [])
+
+const canvas = (
+  <ImageCanvas
+    {...settings}
+    showCrosshairs={
+      settings.showCrosshairs &&
+      !["select", "pan", "zoom"].includes(state.selectedTool)
+    }
+    key={state.selectedImage}
+    showMask={state.showMask}
+    fullImageSegmentationMode={state.fullImageSegmentationMode}
+    autoSegmentationOptions={state.autoSegmentationOptions}
+    showTags={state.showTags}
+    allowedArea={state.allowedArea}
+    modifyingAllowedArea={state.selectedTool === "modify-allowed-area"}
+    regionClsList={state.regionClsList}
+    regionTagList={state.regionTagList}
+    regions={
+      state.annotationType === "image"
+        ? activeImage.regions || []
+        : impliedVideoRegions
+    }
+    realSize={activeImage ? activeImage.realSize : undefined}
+    videoPlaying={state.videoPlaying}
+    imageSrc={state.annotationType === "image" ? activeImage.src : null}
+    videoSrc={state.annotationType === "video" ? state.videoSrc : null}
+    pointDistancePrecision={state.pointDistancePrecision}
+    createWithPrimary={state.selectedTool.includes("create")}
+    dragWithPrimary={state.selectedTool === "pan"}
+    zoomWithPrimary={state.selectedTool === "zoom"}
+    showPointDistances={state.showPointDistances}
+    videoTime={
+      state.annotationType === "image"
+        ? state.selectedImageFrameTime
+        : state.currentVideoTime
+    }
+    keypointDefinitions={state.keypointDefinitions}
+    onMouseMove={action("MOUSE_MOVE")}
+    onMouseDown={action("MOUSE_DOWN")}
+    onMouseUp={action("MOUSE_UP")}
+    onChangeRegion={action("CHANGE_REGION", "region")}
+    onBeginRegionEdit={action("OPEN_REGION_EDITOR", "region")}
+    onCloseRegionEdit={action("CLOSE_REGION_EDITOR", "region")}
+    onDeleteRegion={action("DELETE_REGION", "region")}
+    onBeginBoxTransform={action("BEGIN_BOX_TRANSFORM", "box", "directions")}
+    onBeginMovePolygonPoint={action(
+      "BEGIN_MOVE_POLYGON_POINT",
+      "polygon",
+      "pointIndex"
+    )}
+    onBeginMoveKeypoint={action(
+      "BEGIN_MOVE_KEYPOINT",
+      "region",
+      "keypointId"
+    )}
+    onAddPolygonPoint={action(
+      "ADD_POLYGON_POINT",
+      "polygon",
+      "point",
+      "pointIndex"
+    )}
+    onSelectRegion={action("SELECT_REGION", "region")}
+    onBeginMovePoint={action("BEGIN_MOVE_POINT", "point")}
+    onImageLoaded={action("IMAGE_LOADED", "image")}
+    RegionEditLabel={RegionEditLabel}
+    onImageOrVideoLoaded={action("IMAGE_OR_VIDEO_LOADED", "metadata")}
+    onChangeVideoTime={action("CHANGE_VIDEO_TIME", "newTime")}
+    onChangeVideoPlaying={action("CHANGE_VIDEO_PLAYING", "isPlaying")}
+    onRegionClassAdded={onRegionClassAdded}
+    allowComments={state.allowComments}
+    hideNotEditingLabel={hideNotEditingLabel}
+    allowedGroups={allowedGroups}
+  />
+)
+
+const onClickIconSidebarItem = useEventCallback((item) => {
+  dispatch({ type: "SELECT_TOOL", selectedTool: item.name })
+})
+
+const onClickHeaderItem = useEventCallback((item) => {
+  if (item.name === "Fullscreen") {
+    fullScreenHandle.enter()
+  } else if (item.name === "Window") {
+    fullScreenHandle.exit()
+  }
+  dispatch({ type: "HEADER_BUTTON_CLICKED", buttonName: item.name })
+})
+
+const debugModeOn = Boolean(window.localStorage.$ANNOTATE_DEBUG_MODE && state)
+const nextImageHasRegions =
+  !nextImage || (nextImage.regions && nextImage.regions.length > 0)
+
+// Editor.js blocks
+const selectedGroupId = state.images[state.selectedImage]?.selectedGroupId || null;
+const editorBlocks = regionsToBlocks(state.images[state.selectedImage]?.regions || []);
+const blocks = editorBlocks.filter(i => i?.data?.groupId === selectedGroupId);
+
+const handleEditorChange = ({ imageIndex, data }) => {
+  const newRegions = data.blocks.map(i => ({
+    id: i.id,
+    cls: i.data.labelName,
+    text: i.data.text
+  }))
+  dispatch({ type: "UPDATE_REGIONS", regions: newRegions, imageIndex })
+}
+
+const pages = state.images.map((i, idx) => ({
+  id: idx,
+  src: i.src,
+  isActive: idx === state.selectedImage,
+  pageNumber: i?.metadata?.find(md => md.key === "page").value || null
+}))
+
+const handlePageClick = (pageIndex) => {
+  dispatch({ type: "SELECT_IMAGE", imageIndex: pageIndex })
+}
+
+return (
+  <ThemeProvider theme={theme}>
+    <FullScreenContainer>
+      <FullScreen
+        handle={fullScreenHandle}
+        onChange={(open) => {
+          if (!open) {
+            fullScreenHandle.exit()
+            action("HEADER_BUTTON_CLICKED", "buttonName")("Window")
+          }
+        }}
+      >
+        <HotkeyDiv
+          tabIndex={-1}
+          divRef={innerContainerRef}
+          onMouseDown={refocusOnMouseEvent}
+          onMouseOver={refocusOnMouseEvent}
+          allowChanges
+          handlers={hotkeyHandlers}
+          className={classnames(
+            classes.container,
+            state.fullScreen && "Fullscreen"
+          )}
+        >
+          <div style={{
+            display: 'flex',
+            flexDirection: 'row'
+          }}>
+            {
+              showPageSelector && (
+                <PagesSelector pages={pages} onPageClick={handlePageClick} onRecalc={onRecalc} onSave={onSave} saveActive={saveActive} recalcActive={recalcActive} />
+              )
+            }
+            <Workspace
+              allowFullscreen
+              iconDictionary={iconDictionary}
+              hideHeader={hideHeader}
+              hideHeaderText={hideHeaderText}
+              headerLeftSide={[
+                state.annotationType === "video" ? (
+                  <KeyframeTimeline
+                    currentTime={state.currentVideoTime}
+                    duration={state.videoDuration}
+                    onChangeCurrentTime={action("CHANGE_VIDEO_TIME", "newTime")}
+                    keyframes={state.keyframes}
+                  />
+                ) : activeImage ? (
+                  <div className={classes.headerTitle}>{activeImage.name}</div>
+                ) : null,
+              ].filter(Boolean)}
+              headerItems={[
+                !hidePrev && { name: "Prev" },
+                !hideNext && { name: "Next" },
+                state.annotationType !== "video"
+                  ? null
+                  : !state.videoPlaying
+                    ? { name: "Play" }
+                    : { name: "Pause" },
+                !hideClone &&
+                !nextImageHasRegions &&
+                activeImage.regions && { name: "Clone" },
+                !hideSettings && { name: "Settings" },
+                !hideFullScreen &&
+                (state.fullScreen
+                  ? { name: "Window" }
+                  : { name: "Fullscreen" }),
+                !hideSave && { name: "Save" },
+              ].filter(Boolean)}
+              onClickHeaderItem={onClickHeaderItem}
+              onClickIconSidebarItem={onClickIconSidebarItem}
+              selectedTools={[
+                state.selectedTool,
+                state.showTags && "show-tags",
+                state.showMask && "show-mask",
+              ].filter(Boolean)}
+              iconSidebarItems={[
+                {
+                  name: "select",
+                  helperText: "Select" + getHotkeyHelpText("select_tool"),
+                  alwaysShowing: true,
+                },
+                {
+                  name: "pan",
+                  helperText:
+                    "Drag/Pan (right or middle click)" +
+                    getHotkeyHelpText("pan_tool"),
+                  alwaysShowing: true,
+                },
+                {
+                  name: "zoom",
+                  helperText:
+                    "Zoom In/Out (scroll)" + getHotkeyHelpText("zoom_tool"),
+                  alwaysShowing: true,
+                },
+                {
+                  name: "show-tags",
+                  helperText: "Show / Hide Tags",
+                  alwaysShowing: true,
+                },
+                {
+                  name: "create-point",
+                  helperText: "Add Point" + getHotkeyHelpText("create_point"),
+                },
+                {
+                  name: "create-box",
+                  helperText:
+                    "Add Bounding Box" +
+                    getHotkeyHelpText("create_bounding_box"),
+                },
+                {
+                  name: "create-polygon",
+                  helperText:
+                    "Add Polygon" + getHotkeyHelpText("create_polygon"),
+                },
+                {
+                  name: "create-line",
+                  helperText: "Add Line",
+                },
+                {
+                  name: "create-expanding-line",
+                  helperText: "Add Expanding Line",
+                },
+                {
+                  name: "create-keypoints",
+                  helperText: "Add Keypoints (Pose)",
+                },
+                state.fullImageSegmentationMode && {
+                  name: "show-mask",
+                  alwaysShowing: true,
+                  helperText: "Show / Hide Mask",
+                },
+                {
+                  name: "modify-allowed-area",
+                  helperText: "Modify Allowed Area",
+                },
+              ]
+                .filter(Boolean)
+                .filter(
+                  (a) => a.alwaysShowing || state.enabledTools.includes(a.name)
+                )}
+              rightSidebarItems={[
+                debugModeOn && (
+                  <DebugBox state={debugModeOn} lastAction={state.lastAction} />
+                ),
+                state.taskDescription && (
+                  <TaskDescription description={state.taskDescription} />
+                ),
+                state.regionClsList && (
+                  <ClassSelectionMenu
+                    selectedCls={state.selectedCls}
+                    regionClsList={state.regionClsList}
+                    onSelectCls={action("SELECT_CLASSIFICATION", "cls")}
+                  />
+                ),
+                state.labelImages && (
+                  <TagsSidebarBox
+                    currentImage={activeImage}
+                    imageClsList={state.imageClsList}
+                    imageTagList={state.imageTagList}
+                    onChangeImage={action("CHANGE_IMAGE", "delta")}
+                    expandedByDefault
+                  />
+                ),
+                // (state.images?.length || 0) > 1 && (
+                //   <ImageSelector
+                //     onSelect={action("SELECT_REGION", "region")}
+                //     images={state.images}
+                //   />
+                // ),
+                // groups && (
+                //   <GroupSelector
+                //     title="Articles"
+                //     groups={groups}
+                //     selectedGroupId={selectedGroupId}
+                //     onSelect={onGroupSelect}
+                //   />
+                // )
+                ,
+                <RegionSelector
+                  regions={activeImage ? activeImage.regions : emptyArr}
+                  onSelectRegion={action("SELECT_REGION", "region")}
+                  onDeleteRegion={action("DELETE_REGION", "region")}
+                  onChangeRegion={action("CHANGE_REGION", "region")}
+                />,
+                state.keyframes && (
+                  <KeyframesSelector
+                    onChangeVideoTime={action("CHANGE_VIDEO_TIME", "newTime")}
+                    onDeleteKeyframe={action("DELETE_KEYFRAME", "time")}
+                    onChangeCurrentTime={action("CHANGE_VIDEO_TIME", "newTime")}
+                    currentTime={state.currentVideoTime}
+                    duration={state.videoDuration}
+                    keyframes={state.keyframes}
+                  />
+                ),
+                !hideHistory && (
+                  <HistorySidebarBox
+                    history={state.history}
+                    onRestoreHistory={action("RESTORE_HISTORY")}
+                  />
+                ),
+                <MetadataEditor state={state} onMetadataChange={onMetadataChange} />
+              ].filter(Boolean)}
+            >
+              {canvas}
+            </Workspace>
+            {
+              (showEditor) && (
+                <EditorWrapper id="editor-wrapper">
+                  <Editor id="editor" blocks={blocks} imageIndex={state.selectedImage} key={`${state.selectedImage}#${selectedGroupId}`} onChange={handleEditorChange} />
+                </EditorWrapper>
+              )
+            }
+          </div>
+          <SettingsDialog
+            open={state.settingsOpen}
+            onClose={() =>
+              dispatch({
+                type: "HEADER_BUTTON_CLICKED",
+                buttonName: "Settings",
+              })
+            }
+          />
+        </HotkeyDiv>
+      </FullScreen>
+    </FullScreenContainer>
+  </ThemeProvider >
+)
+}
+
+export default MainLayout