クラス vrReferenceService()

(vrBaseService を継承)

参照サービスには、参照ノードを照会および管理するための関数が用意されています。また、基本設定の設定を照会することもできます。

概要

関数:

• convertToSmart(node, useSourcePath) → vrdNode
• createSmart(parent) → vrdReferenceNode
• createSource(path, parent) → vrdReferenceNode
• getAllAvailableFileFormats() → List[string]
• getChildReferences(node) → List[vrdReferenceNode]
• getCustomExportPath() → string
• getExportLocation() → vrReferenceTypes.ExportLocation
• getLoadMode() → vrReferenceTypes.LoadMode
• getNotificationMode() → vrReferenceTypes.NotificationMode
• getParentReferences(node) → List[vrdReferenceNode]
• getReferences(node) → List[vrdReferenceNode]
• getRevisionMonitoringEnabled() → bool
• getRevisionMonitoringExpressions() → List[string]
• getSceneReferences() → List[vrdReferenceNode]
• getShowConvertToSmartWarning() → bool
• getUpdateMonitoringEnabled() → bool
• getUpdateMonitoringInterval() → integer
• getUpdateMonitoringPaused() → bool
• loadSourceReferences(references)
• pauseUpdateMonitoring(state)
• reimportSmartReferences(references)
• reimportSourceReferences(references) → List[vrdReferenceNode]
• removeReference(node) → vrdNode
• setCustomExportPath(path)
• setExportLocation(value)
• setLoadMode(value)
• setNotificationMode(value)
• setRevisionMonitoringEnabled(value)
• setRevisionMonitoringExpressions(expressions)
• setShowConvertToSmartWarning(value)
• setUpdateMonitoringEnabled(value)
• setUpdateMonitoringInterval(msecs)
• sortRevisions(revisions) → List[string]

信号:

• referenceCreated(node)
• referenceEditStateChagned()
• referencesChanged(nodes)
• sceneHasReferences(state)
• sceneSelectionChanged(nodes)
• updateMonitoringChanged(state)

関数

vrReferenceService.convertToSmart(node, useSourcePath=False)

渡されたノードをスマート参照に変換します。

• パラメータ

  • node (vrdNode): 変換する必要があるノード。変換できない場合は、ノードの上に新しいスマート参照が挿入されます。
  • useSourcePath (bool): ソース参照のパスを変換に使用します。

• 戻り値

  変換/作成された参照ノード

• 戻り値の型

  vrdNode

vrReferenceService.createSmart(parent=vrdNode())

指定した親の下に新しいスマート参照を作成します。

• パラメータ

  parent (vrdNode): 参照ノードを追加する親ノード。親が指定されていない場合、参照はシーンのルートの下に作成されます

• 戻り値

  作成された参照ノード

• 戻り値の型

  vrdReferenceNode

vrReferenceService.createSource(path, parent=vrdNode())

指定したパスを持つ新しいソース参照を作成します。

• パラメータ

  • path (string): ファイルのパス
  • parent (vrdNode): 参照ノードを追加する親ノード。親が指定されていない場合、参照はシーンのルートの下に作成されます

• 戻り値

  作成された参照ノード

• 戻り値の型

  vrdReferenceNode

vrReferenceService.getAllAvailableFileFormats()

ロードされた参照(ソースとスマート)で使用されるすべてのファイル拡張子を含むリストを返します。

• 戻り値

  使用可能なファイル形式。

• 戻り値の型

  List[string]

vrReferenceService.getChildReferences(node)

ノードの下のツリー内のすべての参照ノードを、これ以上サブ参照を含めないで取得します。

• パラメータ

  node (vrdNode): 検索するツリーのルート ノード

• 戻り値

  クローンを含む参照ノードのリスト

• 戻り値の型

  List[vrdReferenceNode]

vrReferenceService.getCustomExportPath()

カスタムの書き出しパスを照会します。

• 戻り値

  ファイル システムのパス

• 戻り値の型

  string

vrReferenceService.getExportLocation()

既定のスマート書き出し場所モードを照会します。

• 戻り値

  既定の書き出し場所モード

• 戻り値の型

  vrReferenceTypes.ExportLocation

vrReferenceService.getLoadMode()

スマート参照のロード モードを照会します。

• 戻り値

  現在のロード モード

• 戻り値の型

  vrReferenceTypes.LoadMode

vrReferenceService.getNotificationMode()

現在のファイル変更通知モードを照会します。

• 戻り値

  通知モード

• 戻り値の型

  vrReferenceTypes.NotificationMode

vrReferenceService.getParentReferences(node)

ノードの上のツリー内のすべての参照ノードを取得します。

• パラメータ

  node (vrdNode): 検索するツリーのノード

• 戻り値

  クローンを含む参照ノードのリスト

• 戻り値の型

  List[vrdReferenceNode]

vrReferenceService.getReferences(node)

指定したノードの下にあるすべての参照ツリーを、すべてのサブ参照を含めて取得します。

• パラメータ

  node (vrdNode): 検索するツリーのルート ノード

• 戻り値

  クローンを含まない参照ノードのリスト

• 戻り値の型

  List[vrdReferenceNode]

vrReferenceService.getRevisionMonitoringEnabled()

• 戻り値

  更新の監視でファイルのリビジョンを考慮する必要がある場合は、True

• 戻り値の型

  bool

vrReferenceService.getRevisionMonitoringExpressions()

• 戻り値

  ファイル名のリビジョン番号を検出するために使用される正規表現のリスト

• 戻り値の型

  List[string]

vrReferenceService.getSceneReferences()

シーン内のすべての参照を取得します。

• 戻り値

  クローンを含まない参照ノードのリスト

• 戻り値の型

  List[vrdReferenceNode]

vrReferenceService.getShowConvertToSmartWarning()

スマート警告フラグへの変換を照会します。

• 戻り値

  警告が有効な場合は True

• 戻り値の型

  bool

vrReferenceService.getUpdateMonitoringEnabled()

更新の監視が現在有効かどうかを確認します。

• 戻り値

  更新の監視が有効な場合は True、それ以外の場合は False です。

• 戻り値の型

  bool

vrReferenceService.getUpdateMonitoringInterval()

現在のバックグラウンド更新チェックの間隔をミリ秒単位で返します。

• 戻り値

  更新の監視の間隔。

• 戻り値の型

  integer

vrReferenceService.getUpdateMonitoringPaused()

バックグラウンド更新の監視が現在一時停止モードになっているかどうかを照会します。

• 戻り値

  更新チェックが一時停止されている場合は True、それ以外の場合は False を返します。

• 戻り値の型

  bool

vrReferenceService.loadSourceReferences(references)

読み込みダイアログを開き、現在の設定を使用して、指定した参照リストをロードします。ユーザ操作は必要ありません。

• パラメータ

  references (List[vrdReferenceNode]): ロードする参照のリスト。

vrReferenceService.pauseUpdateMonitoring(state)

バックグラウンド更新の監視を一時的に一時停止/一時停止解除します。非同期の更新チェックは中止されますが、キャンセルはされません。

• パラメータ

  state (bool): True の場合は一時停止し、False の場合は一時停止を解除します。

vrReferenceService.reimportSmartReferences(references)

指定したスマート参照のリストを再読み込みします。

• パラメータ

  references (List[vrdReferenceNode]): スマート参照のリスト。

vrReferenceService.reimportSourceReferences(references)

指定した参照リストの読み込みダイアログを開きます。

• パラメータ

  references (List[vrdReferenceNode]): 再ロードする参照のリスト。

• 戻り値

  再読み込みされた参照ノードのリスト。

• 戻り値の型

  List[vrdReferenceNode]

vrReferenceService.removeReference(node)

渡されたノードを参照なしノードに変換します。

• パラメータ

  node (vrdReferenceNode): 変換する参照ノード。

• 戻り値

  変換されたノード

• 戻り値の型

  vrdNode

vrReferenceService.setCustomExportPath(path)

書き出されたスマート参照のカスタム パスを設定します。場所がカスタムに設定されている場合は、このパスが使用されます。

• パラメータ

  path (string): ファイル システムの有効なパス

vrReferenceService.setExportLocation(value)

保存されていないスマート参照の既定の場所モードを変更します。

• パラメータ

  value (vrReferenceTypes.ExportLocation): 場所モード

vrReferenceService.setLoadMode(value)

スマート参照のロード モードを設定します。

• LoadedReferences > プロジェクトに保存されたロード状態を保持します。

• AllReferences > すべてのスマート参照をロードします。

• NoReferences > スマート参照をロードしません。

• LoadedSkipLeafReferences > 参照ツリーのリーフ以外のすべてのものをロードします。

• パラメータ

  value (vrReferenceTypes.LoadMode): ロード モード

vrReferenceService.setNotificationMode(value)

ファイル変更通知の監視モードを設定します。

• パラメータ

  value (vrReferenceTypes.NotificationMode): 新しいモード。

vrReferenceService.setRevisionMonitoringEnabled(value)

更新を監視するためのリビジョン番号チェックを有効にします。

• パラメータ

  value (bool): 新しい値

vrReferenceService.setRevisionMonitoringExpressions(expressions)

リビジョン番号の検出に使用される正規表現のリストを設定します。

• パラメータ

  expressions (List[string]): 正規表現のリスト

vrReferenceService.setShowConvertToSmartWarning(value)

スマートへの変換に関する警告を有効または無効にします。

• パラメータ

  value (bool): True の場合は警告を表示します

vrReferenceService.setUpdateMonitoringEnabled(value)

バックグラウンドの更新の開始を開始または停止します。

これにより、ロードされた参照内で更新を継続的にスキャンする更新チェックが開始または停止されます。スマート参照とソース参照の両方を監視します。更新が入手可能な場合は、vrReferenceService.referencesChanged(nodes) が送信されます。

• パラメータ

  value (bool): true の場合は更新の監視を開始し、false の場合は停止します。

vrReferenceService.setUpdateMonitoringInterval(msecs)

更新の監視の間隔をミリ秒単位で設定します。最小値は 1000 です。

• パラメータ

  msecs (integer): バックグラウンド更新チェックの間隔。

vrReferenceService.sortRevisions(revisions)

古いものから新しいものへリビジョンのリストを並べ替えます。

• パラメータ

  revisions (List[string]) –

• 戻り値

  並べ替えられたリビジョン リスト。

• 戻り値の型

  List[string]

信号

vrReferenceService.referenceCreated(node)

参照が作成されている場合は、信号が送信されます。

• パラメータ

  node (vrdReferenceNode): 作成されたノード。

vrReferenceService.referenceEditStateChagned()

参照が編集されているか、編集が元に戻されている場合は、信号が送信されます。

vrReferenceService.referencesChanged(nodes)

参照が内部で変更されている場合は、信号が送信されます。ノードのリストが空の場合は、すべてのノードが変更されていると見なす必要があります。

• パラメータ

  nodes (List[vrdReferenceNode]): 変更された参照ノードのリスト。

vrReferenceService.sceneHasReferences(state)

シーンに参照が含まれているか、最後の参照が削除されている場合は、信号が送信されます。

• パラメータ

  state (bool): 最初の参照が作成またはロードされている場合は true、最後の参照がシーンから削除されている場合は false を返します。

vrReferenceService.sceneSelectionChanged(nodes)

この信号は、シーングラフ内の参照ノードの選択が変更されたときに送信されます。

• パラメータ

  nodes (List[vrdReferenceNode]): 選択したすべての参照ノードのリスト

vrReferenceService.updateMonitoringChanged(state)

更新の監視がオンまたはオフになると、信号が送信されます。

• パラメータ

  state (bool): 更新の監視がオンになった場合は True。