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