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