vrFileIOService

クラス vrFileIOService

(vrBaseService を継承)

概要

関数:
信号:

関数

vrFileIOService.abortImport(importId)

読み込みジョブを中止します。

パラメータ:importId (integer): 読み込みジョブの識別子。

vrFileIOService.abortJobs(jobIds)

保留中または実行中の読み込みジョブまたは書き出しジョブを中止します。

パラメータ:jobIds (List[integer]): ジョブの識別子。

vrFileIOService.checkCadType(file)

指定したファイル パスを持つファイルの CAD ファイル タイプの照会を非同期に開始します。タイプの照会に成功するか、キャッシュ内での検索が終了すると、fileTypeReceived 信号が送信されます。これが必要になる理由としては、一部のファイル拡張子(.prt など)を単一のファイル タイプに明確に関連付けられないことなどが挙げられます。

パラメータ:file (string): CAD ファイルのファイル名

vrFileIOService.enableNewFormat()

新しいファイル形式を有効にします。新しいファイル形式の方が高速で、安全です。

vrFileIOService.exportNodes(file, nodes, synchronousConversion=False)

ノードをファイルに書き出します。「vrFileIOService.exportedFile(filename)」も参照してください

パラメータ:
  • file (string): ファイルのパス
  • nodes (List[vrdNode]): 書き出すノード
  • synchronousConversion (bool): True の場合、変換が完了するまで関数は待機します。
戻り値:

変換ジョブの識別子です。書き出しが既に完了している場合は「0」になります。
戻り値の型:

integer

vrFileIOService.getBaseFileSuffix(file)

ファイル拡張子を返します。

パラメータ:file (string): ファイル名
戻り値:ファイル拡張子。
戻り値の型:string

vrFileIOService.getExportSettings(fileType)

指定した CAD ファイル タイプの現在の書き出し設定を取得します。

パラメータ:fileType (vrCADFileTypes.FileType): 書き出し設定を返すファイル タイプ。
戻り値:書き出し設定。
戻り値の型:vrdFileExportSettings

vrFileIOService.getExportSettingsFromPreferences(fileType)

基本設定から書き出し設定を取得します。

パラメータ:fileType (vrCADFileTypes.FileType): 書き出し設定を返すファイル タイプ。
戻り値:基本設定の書き出し設定。
戻り値の型:vrdFileExportSettings

vrFileIOService.getFileName()

現在のファイル名を取得します。

戻り値:ファイル名。
戻り値の型:string

vrFileIOService.getFileTypeByFileName(file)

ファイル名でファイルタイプを取得します。

パラメータ:file (string): ファイル名
戻り値:ファイル名のファイルタイプ。
戻り値の型:vrCADFileTypes.FileType

vrFileIOService.getImageReadFilter()

これにより、ロードできるサポート対象イメージ ファイル タイプのスペース区切りリストが返されます。

戻り値:ロードできるサポート対象イメージ ファイルのタイプ
戻り値の型:string

vrFileIOService.getImageWriteFilter()

これにより、保存できるサポート対象イメージ ファイル タイプのスペース区切りリストが返されます。

戻り値:保存できるサポート対象イメージ ファイルのタイプ
戻り値の型:string

vrFileIOService.getImportSettings(fileType)

指定した CAD ファイル タイプの現在の読み込み設定を取得します。

パラメータ:fileType (vrCADFileTypes.FileType): 読み込み設定を返すファイル タイプ。
戻り値:読み込み設定。
戻り値の型:vrdAtfSettings

vrFileIOService.getImportSettingsFromPreferences(fileType)

基本設定から読み込み設定を取得します。

パラメータ:fileType (vrCADFileTypes.FileType): 読み込み設定を返すファイル タイプ。
戻り値:基本設定の読み込み設定。
戻り値の型:vrdAtfSettings

vrFileIOService.getMaxNumImportProcesses()

読み込みプロセスの最大数を返します。

戻り値:読み込みプロセスの最大数。
戻り値の型:integer

vrFileIOService.getMergeProjectAnnotations()

ロード後にプロジェクト ファイルに含まれる注釈を結合するかどうかを示すフラグ。

戻り値:注釈の結合フラグ。
戻り値の型:bool

vrFileIOService.getProjectMergeSettings()

プロジェクトの結合設定を取得します。

戻り値:現在のプロジェクトの結合設定。
戻り値の型:vrdProjectMergeSettings

vrFileIOService.getReadFileTypesFilter(mode)

読み込み可能なファイル タイプのフィルタを取得します。

パラメータ:mode (vrFileTypes.FileExtensionFilterMode) –
戻り値:読み込み可能なファイル タイプのフィルタ。
戻り値の型:string

vrFileIOService.getSceneImportSettings()

シーンの現在のシーン読み込み設定を取得します。

戻り値:シーンの読み込み設定。
戻り値の型:vrdSceneImportSettings

vrFileIOService.getSceneImportSettingsFromPreferences()

基本設定からシーンの読み込み設定を取得します。

戻り値:基本設定のシーンの読み込み設定。
戻り値の型:vrdSceneImportSettings

vrFileIOService.getStreamName()

現在のストリーム名を取得します。

戻り値:ストリーム名。
戻り値の型:string

vrFileIOService.getVREDDataDir()

VRED データ フォルダを取得します。これは、ベース フォルダの「data」サブフォルダです。

戻り値:VRED データ フォルダ。
戻り値の型:string

vrFileIOService.getVREDDir()

ベース アプリケーション フォルダを取得します。

戻り値:ベース アプリケーション フォルダ。
戻り値の型:string

vrFileIOService.getVREDExamplesDir()

VRED サンプル フォルダを取得します。これは、ベース フォルダの「examples」サブフォルダです。

戻り値:VRED サンプル フォルダ。
戻り値の型:string

vrFileIOService.getVREDFileTypesFilter()

VRED ファイル タイプのフィルタを取得します。

戻り値:VRED ファイル タイプのフィルタ。
戻り値の型:string

vrFileIOService.getWriteFileTypesFilter(filename='', includeExportFormats=True)

書き込み可能なファイル タイプのフィルタを取得します。

パラメータ:
  • filename (string): ファイル拡張子付きのオプションの現在のファイル名
  • includeExportFormats (bool): True の場合、書き出しタイプを追加します
戻り値:

書き込み可能なファイル タイプのフィルタ。
戻り値の型:

string

vrFileIOService.hasImportSettings(file)

指定したファイルの読み込み設定があるかどうかを判別します。

パラメータ:file (string): ファイル名
戻り値:読み込み設定がある場合は True、ない場合は False。
戻り値の型:bool

vrFileIOService.hasImportSettings(fileType)

指定したファイル タイプの読み込み設定があるかどうかを判別します。

パラメータ:fileType (vrCADFileTypes.FileType): ファイル タイプ
戻り値:読み込み設定がある場合は True、ない場合は False。
戻り値の型:bool

vrFileIOService.hasSmartReferences(file)

OSB または VPB ファイルにスマート参照が含まれているかどうかを照会します。

パラメータ:file (string): VPB または OSB ファイルのファイル名
戻り値:ファイルにスマート参照が含まれている場合は True。
戻り値の型:bool

vrFileIOService.importAtfFile(file, parent)

ATF ローダを使用してファイルを読み込みます。

パラメータ:
  • file (string): ファイル名。
  • parent (vrdNode): 読み込まれたファイルがアタッチされる親シーン ノード
戻り値:

変換されたシーン ノード
戻り値の型:

vrdNode

vrFileIOService.importFiles(files, parent, atfConversionOutputDir='', loadConvertedAtfFiles=True, removeConvertedAtfFiles=True, loadBehavior=True)

ファイルのリストを読み込みます。

パラメータ:
  • files (List[string]): 読み込むファイル。
  • parent (vrdNode): これらのファイルを追加する必要があるシーン ツリー内の親ノード。
  • atfConversionOutputDir (string): ATF 変換出力フォルダ
  • loadConvertedAtfFiles (bool): 変換された ATF ファイルをロードする必要がある場合は True
  • removeConvertedAtfFiles (bool): 変換された ATF ファイルを削除する必要がある場合は True
  • loadBehavior (bool): true の場合、読み込まれた VPB ファイルのルート ノードが参照ノードであれば、シーングラフ内のルート ノードを参照としてマークします。
戻り値:

読み込みジョブの識別子。
戻り値の型:

integer

vrFileIOService.importMissingFiles(node, removeConvertedAtfFiles=True)

見つからないファイルをシーン ノードから読み込みます。

パラメータ:
  • node (vrdNode): ロード解除されたパーツを含むシーン ノード
  • removeConvertedAtfFiles (bool): 既に変換されている ATF ファイルを削除します
戻り値:

見つからないファイルに対する新しい読み込みジョブの読み込み ID
戻り値の型:

integer

vrFileIOService.importPLMXMLFile(file, parent)

PLMXML ファイルとそのファイルが参照するファイルを読み込みます。

パラメータ:
  • file (string): ファイル名。
  • parent (vrdNode): 読み込まれたファイルがアタッチされる親シーン ノード
戻り値:

変換されたシーン ノード
戻り値の型:

vrdNode

vrFileIOService.inlineImageSequences()

すべてのイメージ シーケンスをインラインで配置します。

vrFileIOService.isAtfFile(file)

指定したファイルを ATF で読み込めるかどうかを確認します。

パラメータ:file (string): 確認するファイル名
戻り値:ファイルを読み込める場合は True、読み込めない場合は False。
戻り値の型:bool

vrFileIOService.isConvertedAtfTree(root)

シーン ノードが変換された ATF ツリーであるかどうかを確認します。

パラメータ:root (vrdNode): ツリーのルート ノード
戻り値:変換された ATF ツリーの場合は True、それ以外の場合は False。
戻り値の型:bool

vrFileIOService.isReadOnly()
戻り値:現在のプロジェクトが読み取り専用の場合は True
戻り値の型:bool

vrFileIOService.isSupportedFile(file)

指定したファイルを読み込めるかどうかを確認します。

パラメータ:file (string): 確認するファイル名
戻り値:サポートされているファイルの場合は True、それ以外の場合は False。
戻り値の型:bool

vrFileIOService.isVredProject(file)

指定したファイルが VRED プロジェクトであるかどうかを確認します。

パラメータ:file (string): 確認するファイル名
戻り値:VRED プロジェクトの場合は True、それ以外の場合は False。
戻り値の型:bool

vrFileIOService.jobBelongsToImport(jobId, importId)

読み込み識別子が指定したジョブに属しているかどうかを確認します。

パラメータ:
  • jobId (integer): ジョブ識別子
  • importId (integer): 読み込み識別子
戻り値:

読み込み ID がジョブに属している場合は True、それ以外の場合は False
戻り値の型:

bool

vrFileIOService.loadFile(file)

ファイルをロードします。

パラメータ:file (string): ロードするファイル。
戻り値:ロードが成功した場合は True、失敗した場合は False。
戻り値の型:bool

vrFileIOService.newFile()

現在のシーンを破棄し、空のファイル名を持つ新しいシーンを作成します。

vrFileIOService.readMaterial(file)

マテリアル アセットからマテリアル ファイルなどをロードします。

パラメータ:file (string): ファイル名
戻り値:マテリアル。
戻り値の型:vrdMaterial

vrFileIOService.reimportNodes(nodes)

参照されたソース ファイルを使用してノードのリストを再読み込みします。

パラメータ:nodes (List[vrdNode]): 再読み込みするシーン ノード。
戻り値:読み込まれたノードのリスト
戻り値の型:List[vrdNode]

vrFileIOService.saveFile(file)

ファイルを保存します。

パラメータ:file (string): 保存するファイル
戻り値:保存が成功した場合は True、失敗した場合は False。
戻り値の型:bool

vrFileIOService.saveNodes(file, nodes, includeEnvironmentGeometries, filterBSides=False)

複数のノードをファイルに保存します。

パラメータ:
  • file (string): ファイルのパス
  • nodes (List[vrdNode]): 保存するノード
  • includeEnvironmentGeometries (bool): True の場合、環境ジオメトリを追加します
  • filterBSides (bool): True の場合、B 面は書き出されません
戻り値:

保存が成功した場合は True、失敗した場合は False。
戻り値の型:

bool

vrFileIOService.setExportSettings(fileType, settings)

指定したファイル タイプのファイル書き出し設定を行います。

パラメータ:

vrFileIOService.setImportSettings(fileType, settings)

指定したファイル タイプの読み込み設定を行います。

パラメータ:

vrFileIOService.setKey(key)

ファイル暗号化のキーを設定します。

パラメータ:key (string): キー

vrFileIOService.setMaxNumImportProcesses(value)

読み込みプロセスの最大数を設定します。

パラメータ:value (integer): 読み込みプロセスの数

vrFileIOService.setProjectMergeSettings(settings)

プロジェクトの結合設定を行います。

パラメータ:settings (vrdProjectMergeSettings): プロジェクトの結合設定のインスタンス。

vrFileIOService.setSceneImportSettings(settings)

シーンの読み込み設定を行います。

パラメータ:settings (vrdSceneImportSettings): シーンの読み込み設定のインスタンス。

vrFileIOService.undoInlineImageSequences()

すべてのインライン イメージ シーケンスを削除します。

vrFileIOService.validateAtfTree(file, root, parent)
パラメータ:

信号

vrFileIOService.childFileImportAdded(jobId, parentFile, childFile)

子 CAD ファイルの読み込みが追加されたときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • parentFile (string): 親ファイル名
  • childFile (string): 子ファイル名

vrFileIOService.childFileImportFinished(jobId, parentFile, childFile)

子 CAD ファイルの読み込みが終了したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • parentFile (string): 親ファイル名
  • childFile (string): 子ファイル名

vrFileIOService.childrenFileConversionFinished(jobId, parentFile, durationInSeconds)

すべての子 CAD ファイルの変換が終了したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • parentFile (string): 親ファイル名
  • durationInSeconds (float): 読み込み期間(秒単位)

vrFileIOService.conversionFinished(importId, durationInSeconds)

ファイル変換ジョブが終了したときに送信されます。

個々のファイルの通知を取得するには、fileConversionFinished 信号を使用します。

パラメータ:
  • importId (integer): 読み込みジョブの識別子。
  • durationInSeconds (float): 変換期間(秒単位)

vrFileIOService.conversionProgressChanged(importId, percent, status)

ファイル変換の進行状況が変化したときに送信されます。

パラメータ:
  • importId (integer): 現在の読み込みの識別子
  • percent (integer): 変換の進行状況(パーセント)
  • status (string): 変換ステータス(「読み込み中」、「変換中」、「処理中」など)

vrFileIOService.exportedFile(filename)

ファイルが書き出された後に送信されます。

パラメータ:filename (string): 書き出されたファイルの名前

vrFileIOService.fileAddedToLoadQueue(jobId, file)

新しい CAD ファイルがロード キューに追加されたときに信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。

vrFileIOService.fileAddedToScene(jobId, file, node)

新しい CAD ファイルが現在のシーンに追加されたときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • node (vrdNode): 追加されたファイルのシーン ノード

vrFileIOService.fileConversionAborted(jobId, file)

CAD ファイルの変換が中止されたときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。

vrFileIOService.fileConversionFailed(jobId, file, description)

CAD ファイルの変換が失敗したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • description (string): エラーの説明

vrFileIOService.fileConversionFinished(jobId, file, state, durationInSeconds)

CAD ファイルの変換が終了したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • state (vrCADFileTypes.JobState): ジョブのステータス
  • durationInSeconds (float): ロード期間(秒単位)

vrFileIOService.fileConversionProgressChanged(jobId, file, percent, status)

CAD ファイルの変換の進行状況が変化したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • percent (integer): 変換の進行状況(パーセント)
  • status (string): ステータスに関するメッセージ

vrFileIOService.fileConversionStarted(jobId, file)

CAD ファイルの変換が開始されたときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。

vrFileIOService.fileConversionSucceded(jobId, file)

CAD ファイルの変換が成功したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。

vrFileIOService.fileLoadingFailed(jobId, file, description)

読み込む CAD ファイルのロードが失敗したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • description (string): エラーの説明

vrFileIOService.fileLoadingFinished(jobId, file, state)

読み込む CAD ファイルのロードが終了したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • state (vrCADFileTypes.JobState): ジョブのステータス

vrFileIOService.fileLoadingProgressChanged(jobId, file, percent, status)

読み込む CAD ファイルのロードの進行状況が変化したときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。
  • percent (integer): ロードの進行状況(パーセント)
  • status (string): ステータスに関するメッセージ

vrFileIOService.fileLoadingStarted(jobId, file)

読み込む CAD ファイルのロードが開始されたときに送信されます。

パラメータ:
  • jobId (integer): 読み込みジョブの識別子
  • file (string): ファイル名。

vrFileIOService.fileTypeReceived(file, fileType)

新しい CAD ファイル タイプを受け取ったときに送信されます。

パラメータ:

vrFileIOService.importFinished(importId, durationInSeconds)

読み込みジョブが終了したときに送信されます。

パラメータ:
  • importId (integer): 現在の読み込みの識別子
  • durationInSeconds (float): 読み込み期間(秒単位)

vrFileIOService.importProgressChanged(importId, percent)

読み込みの進行状況が更新されたときに送信されます。

パラメータ:
  • importId (integer): 現在の読み込みの識別子
  • percent (integer): 読み込みの進行状況(パーセント)

vrFileIOService.loadedGeometry(filename, nodeid)

ジオメトリがロードされた後に送信されます。

パラメータ:
  • filename (string): ジオメトリのファイル名
  • nodeid (integer): ジオメトリのノード ID

vrFileIOService.newScene()

新しいシーンが作成された後に送信されます。

vrFileIOService.preNewScene()

新しいシーンが作成される前に送信されます。

vrFileIOService.preQuit()

VRED が閉じられる前に送信されます。

vrFileIOService.progress(p)

ファイルのロード量の割合(パーセント値)を示すために定期的に送信されます。

パラメータ:p (integer): ロードの進行状況(パーセント)

vrFileIOService.project(loading)

プロジェクトが正常にロードされた後に送信されます。この信号は、エラーが発生してロードが中止された場合に送信されます。

パラメータ:loading (bool): 成功した場合は True です。

vrFileIOService.projectLoad(filename)

プロジェクトのロードが開始されたときに送信されます。

パラメータ:filename (string): ロードされたプロジェクトのファイル名

vrFileIOService.projectLoaded(filename)

プロジェクトが正常にロードされた後に送信されます。この信号は、エラーが発生してロードが中止された場合は送信されません。

パラメータ:filename (string): ロードされたプロジェクトのファイル名

vrFileIOService.projectLoadFinished(filename, success)

プロジェクトがロードされた後に送信されます。ロードが成功したかどうかに関係なく、信号は常に送信されます。

パラメータ:
  • filename (string): ロードされたプロジェクトのファイル名
  • success (bool): ロードが成功したかどうかを示します

vrFileIOService.projectMerged()

プロジェクトが結合された後に送信されます。

vrFileIOService.projectReadyToRender()

プロジェクトがロードされ、レンダリングの準備が整った後に放出されます。

vrFileIOService.projectSave(filename)

プロジェクトを保存しようとすると、信号が送信されます。

パラメータ:filename (string): プロジェクトのファイル名

vrFileIOService.projectSaved(filename)

プロジェクトの保存が終了したときに信号が送信されます。

パラメータ:filename (string): プロジェクトのファイル名

vrFileIOService.savedGeometry(filename)

ジオメトリが保存された後に送信されます。

パラメータ:filename (string): ジオメトリのファイル名

vrFileIOService.startingConversion(importId, fileCount)

ファイル変換が開始されたときに送信されます。

パラメータ:
  • importId (integer): 現在の読み込みの識別子
  • fileCount (integer): ファイルの数

vrFileIOService.startingImport(importId, fileCount)

ファイル読み込みジョブが開始されたときに送信されます。

パラメータ:
  • importId (integer): 現在の読み込みの識別子
  • fileCount (integer): 読み込むファイルの数
親ページ: VRED Python API v2