Integration with Clip Studio Paint

[shun-iwasawa]

This Pull Request implements integration with the animation production software “Clip Studio Paint (CSP)” by Celsys as follows: When you execute the [Apply Timesheet Information to Digital Timesheet] command in CSP, XDTS Viewer will launch, displaying the current timeline from CSP in timesheet format—allowing you to add memos.

[Background Information: Changes in CSP]

• Main Menu > [Animation] > [Timeline] > [Apply Timesheet Information to Digital Timesheet] command,
  which previously only supported integration with Toei Animation Digital Exposure Sheet, will now also support integration with XDTS Viewer.

• When you execute the [Apply Timesheet Information to Digital Timesheet] command, CSP exports the current project's timeline information
  to <Temporary Folder>\ExchangeDigitalTimeSheet\animation.xdts.

  • On Windows, <Temporary Folder> is C:\Users\username\AppData\Local\Temp

• Next, the [Digital Timesheet executable] specified by the user is launched with <Temporary Folder>\ExchangeDigitalTimeSheet\animation.xdts as an argument.

[Features Implemented in Accordance with the Above Specifications]

Special behavior for CSP integration has been implemented as described below, only when XDTS Viewer is launched with <Temporary Folder>\ExchangeDigitalTimeSheet\animation.xdts as an argument:

• In case one or more XDTS files are already opened:

  • A. Synchronize with one of the already opened XDTS files, or
  • B. Choose to synchronize with a newly specified file (an existing path to overwrite, or a new path to export to)

  The user can select between the above options.

  • If A is selected, a confirmation dialog always appears before the chosen file is overwritten. Once confirmed, the existing XDTS file is overwritten with the contents of animation.xdts, and the user is directed to view that file.
  • If B is selected and the specified path already exists, a confirmation dialog likewise appears before it is overwritten. Once confirmed, the existing file is overwritten with the contents of animation.xdts, and the user is directed to view that file.
  • If B is selected and the specified path does not yet exist, animation.xdts is copied to that path without any confirmation, and the user is directed to view the newly created file.

• If no XDTS file is opened (upon initial launch), only option B above will be available.

NOTICE

• Once a sync file has been specified, the “Link to CSP” flag becomes active. If the XDTS Viewer is called again from CSP with animation.xdts as an argument, the XDTS file open in the linked window will be automatically updated with the contents of animation.xdts.

• While a window is linked, its title bar shows “[Linked with Clip Studio Paint]”, and an “Unlink from CSP” command becomes available in its menu, allowing the user to manually break the link at any time.

• However, even if there is a linked XDTS Viewer window, if the contents of the animation.xdts file you are about to replace differ significantly from the contents of the currently open timesheet (e.g., a difference of two or more layers, or a duration difference of 6 frames or more), a confirmation dialog will appear, allowing you to choose whether to continue updating the linked file, specify a different file, or cancel and leave the current link unchanged.

---

Clip Studio Paintとの連携機能

このPull Requestは、セルシス社のアニメーション制作ソフト「Clip Studio Paint (CSP)」の[デジタルタイムシートにタイムシート情報を適用]コマンドを実行したときにXDTS Viewerが立ち上がり、CSPで現在編集中のタイムラインがタイムシートの形式で表示される（そしてメモが描ける）機能を実現します。

【背景：CSP側の更新内容について】

- メインメニュー [アニメーション] > [タイムライン] > [デジタルタイムシートにタイムシート情報を適用] コマンドが、 従来は[東映デジタルタイムシート](https://www.clipstudio.net/ja/dl/toeianimation/)のみとの連携を提供していましたが、新たにXDTS Viewerとの連携が可能になります。

• [デジタルタイムシートにタイムシート情報を適用]コマンドを実行すると、CSPは現在編集中のプロジェクトのタイムライン情報を
  <一時フォルダ>\ExchangeDigitalTimeSheet\animation.xdts
  に書き出します。

  ※ <一時フォルダ>はWindowsの場合、C:\Users\username\AppData\Local\Temp

• 次に、ユーザーが指定した[デジタルタイムシートの実行ファイル]に <一時フォルダ>\ExchangeDigitalTimeSheet\animation.xdtsを引数としてプロセス起動を行います。

【上記の仕様に合わせ実装された機能】

<一時フォルダ>\ExchangeDigitalTimeSheet\animation.xdtsを引数としてXDTS Viewerが起動した場合のみ、下記の通りCSP連携のための特殊な挙動を実装しました。

• 既に開いているXDTSファイルがある場合

  • A.既に開いているXDTSファイルのいずれかと同期するか
  • B.別の指定したファイルと同期するか(既存ファイルなら上書き、新規パスならエクスポート)

  を選択できるようにし、

  • Aを選択した場合は既存のXDTSファイルをanimation.xdtsの内容で上書きして良いかどうかの確認ダイアログが開き、ユーザーの承認後、既存のXDTSファイルがanimation.xdtsの内容で上書きされ、そのファイルを閲覧するようにします。
  • Bを選択し、かつファイルが既に存在する場合は、同様に上書きの確認ダイアログが開きます。ユーザーの承認後、既存のXDTSファイルがanimation.xdtsの内容で上書きされ、そのファイルを閲覧するようにします。
  • Bを選択し、かつ新規ファイル名を入力した場合はanimation.xdtsを指定したパスにコピーし、そのファイルを閲覧するようにします。

• XDTSが開かれていない（最初の起動）の場合、上記Bのみが選択できるようにします。

注意

• 一度同期するファイルが指定された以降は「CSPとのリンク」のフラグが有効になり、CSPからanimation.xdtsを引数としてXDTS Viewerが再度呼ばれた場合は、紐づいたウィンドウで開いているxdtsファイルをanimation.xdtsの内容で自動更新するようにします。

• ウィンドウがCSPとリンクされている間は、タイトルバーに [Clip Studio Paint とリンク中]と表示され、ハンバーガーメニュー内に、手動でリンクを切断できるCSPとのリンクを解除コマンドが追加されます。

• ただし、「CSPとのリンク」状態のXDTS Viewerウィンドウがある状態でも、これから差し替えようとするanimation.xdtsの内容が開いている既存のタイムシートの内容と大きく異なる（レイヤー数が2つ以上異なる、又はdurationが6フレーム以上異なる）場合には確認ダイアログを表示し、現在のリンクを継続してファイルを更新するか／別のファイルを指定するか／キャンセル（リンク状態は維持）するかを選択できるようにします。