Fast Ref API / Overview

Fast Ref API — 概要

Markdownダウンロード

Fast Ref API は、外部スクリプトから Fast Ref ワークフローを自動化するための Python インターフェースです。


v2 主な変更点

項目 v1 v2
Import sys.path 5 行のボイラープレート必須 1 行: from os_fast_ref.api import FastRefAPI
公開メソッド数 16 30
書き込み作業 一部シーン状態で確認ダイアログ表示可 常に silent(ダイアログなし)
FBX 書き出し fbx_options=dict のみ preset= キーワード追加
Alembic 書き出し なし export_abc / export_abc_all / get_abc_default_options
Get Nodes なし(旧 select_* のみ) get_* 7 個(取得 + オプションのシーン選択)
slot 型検証 範囲/空スロットのみ int 型検証追加(bool 含む)
Max 対応バージョン 2022 / 2025 2022 / 2025 / 2027

設計原則

項目 方針
読み取り(READ) UI 不要 — シーン InfoNode から直接読む
書き込み(WRITE) UI 独立 + 常に silent
データロード セッション内キャッシュを活用
FBX / Alembic オプション preset キーワードまたは dict(+ Export Type: ExportMeshes/ExportBones)
公開サーフェス 30 個(semver 約束)

API メソッド一覧(30 個)

カテゴリ メソッド 説明
照会 get_reference_list() シーンのリファレンス一覧を返す
照会 check_file_status() ソースファイルの最新/変更/欠落状態を確認
照会 get_outdated_references() OUTDATED リファレンスのみ返す [v2 新規]
照会 get_fbx_default_options() 現在の FBX デフォルトプリセットオプションを取得
照会 get_abc_default_options() 現在の Alembic デフォルトプリセットオプションを取得
照会 refresh() InfoNode を強制再スキャン [v2 新規]
ノード取得 get_all_objects() スロット全リファレンスノード取得(オプション:シーン選択)
ノード取得 get_skin_meshes() スキンメッシュノード取得(オプション:シーン選択)
ノード取得 get_skin_bones() スキンボーンノード取得(オプション:シーン選択)
ノード取得 get_all_skin_objects() スキンメッシュ+ボーン取得(オプション:シーン選択)
ノード取得 get_duplicate_nodes() 重複名ノード取得(オプション:シーン選択)
ノード取得 get_biped_com() Biped COM ノード取得(オプション:シーン選択)
ノード取得 get_biped_nodes() Biped 全ノード取得(オプション:シーン選択)
管理 add_reference() リファレンス追加
管理 remove_reference() リファレンス削除
管理 replace_reference() リファレンスファイル差し替え
管理 reload_reference() 単一リファレンスのリロード
管理 reload_all_references() 全リファレンスのリロード
管理 reload_outdated_references() OUTDATED のみリロード [v2 新規]
FBX 書き出し export_fbx() 単一リファレンスを FBX 書き出し(preset / Export Type)
FBX 書き出し export_fbx_all() 全リファレンスを一括 FBX 書き出し(preset / Export Type)
Alembic 書き出し export_abc() 単一リファレンスを Alembic 書き出し(preset / Export Type)
Alembic 書き出し export_abc_all() 全リファレンスを一括 Alembic 書き出し
高度 merge_reference() 単一リファレンスをシーンオブジェクトへ変換
高度 merge_all_references() 全リファレンスを一括変換
高度 set_space_activate() ネームスペース ON/OFF 切替
高度 set_unpack() Unpack ON/OFF 切替
高度 convert_to_reference() 選択オブジェクトをリファレンスへ変換
高度 set_namespace() ネームスペース変更
UI update_ui() Fast Ref UI を手動更新



💬

Need help with the API?

Open a support ticket or join the community discussion.

お問い合わせ