Python API V1 和 V2 中的新增功能

查找在 VRED Python API v2 中为每个版本添加和更改的内容。

“了解更多”图标 有关 Python 沙盒的信息和其他安全信息，请参见软件安全。

API v1 和 v2 2025.2 中的新增功能

环境变量

添加了 VRED_FORCE_HTTPS。设置为 1 时，会启用此选项，将传入的未加密 (http) 连接请求重定向到 VRED Web 界面中的加密 (https) 连接请求。“仅加密的 HTTPS”在首选项中灰显，无法通过 UI 进行更改。设置为 0 时，将使用“仅加密的 HTTPS”首选项设置。

Python 示例

添加了以下 Python 示例：

  • 在“其他脚本插件”下 > vrDragAndDropExample
  • 在“代码段”下 > vr_terminal

API V1

向这些类添加了以下函数：

  • vrRenderSettings

    • getOptimizationMode
    • setOptimizationMode
    • getRenderingColorspace
    • setRenderingColorspace

  • vrMovieExport

    • getOptimizationMode
    • setOptimizationMode
    • getRenderingColorspace
    • setRenderingColorspace

  • vrNodeUtils

    • setIsVRNode

  • vrRenderSettings

    • getRaytracingPhotonUseAutomaticRadius

  • vrScenegraph

    • fixDepthOfField

API V2

在 2025.2 中添加了以下新类：

  • vrMaterialEntryType
  • vrUserMimeTypes

在 2025.2 中向这些类添加了以下函数：

  • vrAnnotationService

    • createAnnotationGroup
    • deleteAnnotations
    • duplicateAnnotations

  • vrdMaterial

    • compressTextures

  • vrdObjectSignal

    • getSignal

  • vrdOpenGLInfo

    • getMax3DTextureSize
    • getMaxArrayTextureLayers
    • getMaxCubeMapTextureSize
    • getMaxTextureImageUnits

  • vrdTonemapper

    • getAutoAdjustISO
    • getResponseCurvePower
    • getResponseCurveSaturation
    • setAutoAdjustISO
    • setResponseCurvePower
    • setResponseCurveSaturation

  • vrFileIOService

    • enableNewFormat
    • getSceneImportSettingsFromPreferences
    • setKey

  • vrGPUService

    • gpuInfo

  • vrHMDService

    • isMixedRealityDepthEstimationSupported

  • vrMaterialService

    • compressTextures

  • vrMetadataService

    • getMaterialTags
    • getScenegraphTags

  • vrPhysicsService

    • clearCollisionData
    • hasCollisionData
    • restoreCollisionData
    • storeCollisionData

向 vrCameraTypes 添加了返回类型 CameraSensorResponse 和 AgX_Custom。

对于以下类，我们添加了这些新信号：

  • vrAnnotationService

    • annotationGraphChanged

  • vrFileIOService

    • projectReadyToRender

对于这些类，以下内容已更改：

  • vrAnnotationService

    • createAnnotation

  • vrdVRDevice

    • getSerialNumber

  • vrDeviceService

    • setBlockedDeviceModelsOrSerials
    • getBlockedDeviceModelsOrSerials
    • addBlockedDeviceModelOrSerial
    • removeBlockedDeviceModelOrSerial
    • isBlockedDeviceModelOrSerial

API v1 和 v2 2025.1 中的新增功能

环境变量

更改了 VRED_DISABLE_ADP 的描述。

Python 示例

添加了新的“物理”部分，其中包含两个示例，并在“约束”部分中添加了一个方向盘示例。

API V1

对以下内容进行了更改。有关具体信息，请访问 Python API V1 部分。

对于 vrAnimWidgets，addTranslationControlPoint 的参数和返回值已更改，addTranslationControlPoints (same) 也已更改。

对于这些类，以下内容已更改：

  • vrCamera

    • setFogColorDistance
    • setFogColorHeight
    • setFogNoiseOffsetDistance
    • setFogNoiseOffsetHeight
    • setFogNoiseSizeDistance
    • setFogNoiseSizeHeight
    • setFogRangeHeight

  • vrConnector - setConnectorMousePos 已更改

  • vrInteraction

    • getUseBoundingboxesForInteractionInVR
    • setUseBoundingboxesForInteractionInVR。

  • vrMaterialPtr - setTextureTransform 已更改

  • vrNodeUtils - unshareCores 已更改

  • vrOSGWidget

    • getSuperSampling
    • setSuperSampling
    • setSuperSamplingOnCameraMovement
    • setSuperSamplingQuality
    • getSuperSamplingQuality

  • vrRenderSettings - setRenderVariantSets 已更改

  • vrScenegraph - cloneNodes 已更改

  • 对于 vrSequencer，以下内容已更改：

    • readSequenceXML
    • runSequenceHttp

  • vrVariants - createAndCaptureVariantSet 已更改

  • vrVariantSetPtr - addClippingPlane 已更改

  • vrVredUi - getMainWindow 已更改

  • vrWebOverlay - setFrame 已更改

对于 vrMaterialEditor，enableSubstancePresetCache 的文档已更改。

API V2

我们向 Python API V2 添加了以下类：

  • vrdPhysicsConfig
  • vrdPhysicsConvexConfig
  • vrdPhysicsHullConfig
  • vrdPhysicsInfo
  • vrdPhysicsTrianglesConfig
  • vrPhysicsService
  • vrPhysicsTypes
  • vrLogService
  • vrLogTypes

我们将这些函数添加到以下内容：

  • vrdFileExportSettings

    • getKeepDefaultCameras
    • getTextureCompressionMode
    • getTextureCompressionQuality
    • setKeepDefaultCameras
    • setTextureCompressionMode
    • setTextureCompressionQuality

  • vrdAtfSettings

    • ModelState 枚举
    • getModelState
    • setModelState

  • vrdNode 添加了 isSynchronizedWith

  • vrdViewpointNode 添加了 removePreview

  • vrFileTypes 添加了 TextureCompressionMode 枚举

  • vrImmersiveInteractionService

    • getShowTrackedHandsInMR
    • getUseBoundingBoxCollisionObjects
    • isHandTrackingGestureEnabled
    • setHandTrackingGestureEnabled
    • setShowTrackedHandsInMR
    • setUseBoundingBoxCollisionObjects

对于 vrdSubstanceMaterial，我们在类文档中添加了一个示例。

我们对以下函数进行了这些更改：

  • vrdAtfSettings

    • getUseLegacyLoader()
    • setUseLegacyLoader()。

  • vrdGeometryNode

    • getNormals
    • getPositions
    • getTexCoords
    • setNormals
    • setPositions

  • vrMaterialService

    • getMaterialFromId

  • vrReferenceService

    • setUpdateMonitoringInterval

我们从 vrdLinearGradientStop 中删除了 getSRgbMidColorPosition 和 setSRgbMidColorPosition。

下面的一些类已更改为枚举值。有关具体信息，请访问 Python API V2 部分。

  • vrAnnotationTypes.ScalingMode
  • vrBakeTypes.AmbientOcclusionWeight
  • vrBakeTypes.BakeState
  • vrBakeTypes.BakeType
  • vrBakeTypes.DenoiserType
  • vrBakeTypes.DirectIlluminationMode
  • vrBakeTypes.IlluminationQuality
  • vrBakeTypes.Renderer
  • vrBakeTypes.SubdivisionQuality
  • vrBakeTypes.UVGeneration
  • vrCADFileTypes.FileType
  • vrCADFileTypes.JobState
  • vrCameraTypes.BlendMode
  • vrCameraTypes.CameraAxis
  • vrCameraTypes.CameraCandelaMapping
  • vrCameraTypes.CameraColorspace
  • vrCameraTypes.CameraConstraint
  • vrCameraTypes.CameraEye
  • vrCameraTypes.CameraProjectionMode
  • vrCameraTypes.CameraResponseCurveMode
  • vrCameraTypes.CameraSensorResponse
  • vrCameraTypes.CameraSensorResponseCurveMapping
  • vrCameraTypes.CameraSpace
  • vrCameraTypes.CameraStereoLayout
  • vrCameraTypes.CameraTonemapper
  • vrCameraTypes.CameraTrackType
  • vrCameraTypes.CollisionStructureBuildMethod
  • vrCameraTypes.DepthOfFieldMode
  • vrCameraTypes.FogFalloffMode
  • vrCameraTypes.FovMode
  • vrCameraTypes.InteractiveDofQuality
  • vrCameraTypes.PasteOption
  • vrCameraTypes.TurntableDirection
  • vrCameraTypes.VanishingLinesType
  • vrCameraTypes.ViewpointCreationMode
  • vrClusterTypes.JobType
  • vrFileTypes.FileExtensionFilterMode
  • vrFileTypes.TextureCompressionMode
  • vrGPUTypes.OpenGLFeature
  • vrGPUTypes.OpenGLVendor
  • vrGUIService.DialogType
  • vrGUIService.ViewCubePosition
  • vrGUIService.ViewCubeSize
  • vrGeometryTypes.DecoreMode
  • vrGeometryTypes.DecoreSubObjectMode
  • vrGeometryTypes.DecoreTransparentObjectMode
  • vrGeometryTypes.PrimitiveType
  • vrGeometryTypes.VisibilityMergeMode
  • vrHandTypes.FingerType
  • vrHandTypes.HandRole
  • vrHandTypes.HandTrackingGesture
  • vrHandTypes.HandTrackingType
  • vrImageTypes.LoadOptionsBitmask
  • vrImageTypes.LoadType
  • vrImageTypes.ShareMode
  • vrImmersiveInteractionTypes.ControlMode
  • vrImmersiveInteractionTypes.TeleportGroundMode
  • vrKernelServices.RelativeOperator
  • vrKernelServices.vrMaterialEntryType
  • vrLensFlareTypes.ElementShape
  • vrLensFlareTypes.ElementType
  • vrLensFlareTypes.PresetType
  • vrLensFlareTypes.StarShape
  • vrLightTypes.Attenuation
  • vrLightTypes.LightType
  • vrLightTypes.Unit
  • vrLightTypes.VolumeIlluminationMode
  • vrLogTypes.Level
  • vrLogTypes.LogType
  • vrMainWindow.DockOption
  • vrMainWindow.PaintDeviceMetric
  • vrMainWindow.RenderFlag
  • vrMaterialEntryType
  • vrMaterialTypes.MaterialType
  • vrMaterialTypes.MergeOptions
  • vrMetadataTypes.ChangeFlag
  • vrMetadataTypes.MatrixOrder
  • vrMetadataTypes.ObjectType
  • vrMetadataTypes.ValueType
  • vrNodeService.TraverseChoice
  • vrPhysicsTypes.Axis
  • vrPhysicsTypes.ObjectType
  • vrProductTypes.Type
  • vrReferenceTypes.ExportLocation
  • vrReferenceTypes.FileState
  • vrReferenceTypes.LoadMode
  • vrReferenceTypes.NotificationMode
  • vrReferenceTypes.State
  • vrReferenceTypes.Type
  • vrRenderTypes.FoveatedQualityPreset
  • vrRenderTypes.ShadingQuality
  • vrRoughnessTextureTypes.ValueMapping
  • vrScenegraphTypes.Action
  • vrScenegraphTypes.ChangeFlag
  • vrScenegraphTypes.DuplicateOption
  • vrScenegraphTypes.MirrorMode
  • vrScenegraphTypes.NodeType
  • vrScenegraphTypes.UnshareOption
  • vrScenegraphTypes.VolumeType
  • vrSceneplateTypes.ContentType
  • vrSceneplateTypes.NodeType
  • vrSceneplateTypes.Position
  • vrSceneplateTypes.RepeatMode
  • vrSceneplateTypes.SizeType
  • vrSpectrum.AnalyticFunction
  • vrSpectrum.SpectraDefines
  • vrStyleTypes.ColorTheme
  • vrSubstanceTypes.PresetApplyMode
  • vrTextureTypes.Axis
  • vrTextureTypes.MappingType
  • vrTextureTypes.RepeatMode
  • vrTextureTypes.TriplanarBlendMode
  • vrTransformService.VariantOptionsMode
  • vrTransformTypes.EulerRotationOrder
  • vrTransformTypes.VariantValueBitMask
  • vrUVTypes.PostScaleMode
  • vrUVTypes.PreRotateMode
  • vrUVTypes.PreScaleMode
  • vrUVTypes.SeamMode
  • vrUVTypes.SnapshotMode
  • vrUVTypes.SnapshotStyle
  • vrUVTypes.TileAssignMode
  • vrUVTypes.UVProjectionMode
  • vrUVTypes.UVSet
  • vrVRInputDeviceTypes.VisualizationMode
  • vrXRealityTypes.MarkerTrackingTypes
  • vrXRealityTypes.MarkerTypes
  • vrXRealityTypes.XRRenderMode
  • vrdAreaLightNode.QualityMode
  • vrdAtfSettings.ImporterVersion
  • vrdAtfSettings.ModelState
  • vrdAtfSettings.SmartReferenceBehavior
  • vrdAtfSettings.SourceReferenceBehavior
  • vrdBRDFCommonSettings.LightingMode
  • vrdBRDFCommonSettings.VrsQuality
  • vrdBlendChunk.DstFactor
  • vrdBlendChunk.Equation
  • vrdBlendChunk.SrcFactor
  • vrdBrushOrientation.BrushAxis
  • vrdBrushedMetalMaterial.MetalType
  • vrdBumpTexture.BumpType
  • vrdCarbonPattern.Type
  • vrdCarbonPattern2D.Type
  • vrdCarbonPattern3D.Type
  • vrdChromeMaterial.MetalType
  • vrdChunkMaterial.TransparencyMode
  • vrdClearcoat.Type
  • vrdCubeTextureChunk.InternalFormat
  • vrdCubeTextureChunk.MagFilter
  • vrdCubeTextureChunk.MinFilter
  • vrdCubeTextureChunk.WrapMode
  • vrdDepthTestChunk.DepthFunc
  • vrdDiskLightNode.QualityMode
  • vrdDisplacement.SilhouetteMode
  • vrdDisplacementTexture.DisplacementSilhouetteMode
  • vrdEnvironmentLightSource.LightType
  • vrdEnvironmentMaterial.GeometryType
  • vrdEnvironmentRaytracingSettings.Shadowing
  • vrdFileExportSettings.SurfaceExportMode
  • vrdGLSLShaderParameterList.ParameterType
  • vrdGlassMaterial.DispersionInputType
  • vrdGlassMaterial.FresnelQuality
  • vrdGlassMaterial.MediumType
  • vrdHDRLightStudio.LightPaintMode
  • vrdImmersiveMenu.MenuConstraint
  • vrdImmersiveMenu.MenuOrigin
  • vrdMaterialChunkList.ChunkType
  • vrdMaterialRaytracingSettings.IlluminationMode
  • vrdMetallicCarpaintMaterial.PaintType
  • vrdPolygonChunk.CullFace
  • vrdPolygonChunk.FillMode
  • vrdPolygonChunk.FrontFace
  • vrdRectangularLightNode.QualityMode
  • vrdReflectivePlasticMaterial.FresnelQuality
  • vrdRemoteEngine.TextureSlotType
  • vrdRoundedEdges.EdgeMode
  • vrdRoundedEdges.EdgeType
  • vrdSceneItemInfo.Flags
  • vrdShadowMaterial.OpacityMode
  • vrdShadowMaterial.ReflectionMode
  • vrdSkylightMaterial.GeometryType
  • vrdSkylightSkyAndSun.SkyModel
  • vrdSoundNode.ReverbEffect
  • vrdSoundNode.SpatializeSourceMode
  • vrdSphereEnvironmentMaterial.GeometryType
  • vrdSphericalLightNode.QualityMode
  • vrdSubstanceEnvironmentMaterial.GeometryType
  • vrdSubsurfaceScattering.MediumType
  • vrdSubsurfaceScattering.Mode
  • vrdTextureChunk.InternalFormat
  • vrdTextureChunk.MagFilter
  • vrdTextureChunk.MinFilter
  • vrdTextureChunk.WrapMode
  • vrdTextureEngine.TextureSlotType
  • vrdVolumeScatterMaterial.NoiseMode
  • vrdWebEngine.TextureSlotType
  • vrdWovenClothMaterial.ClothPreset
  • vrdWovenClothMaterial.WeaveType
  • vrdWovenClothMaterial.YarnType

API v1 和 v2 2025 中的新增功能

API V1

以下是新的 Python 类：

  • vrMovieExport：

      • getOcclusionRange

  • vrOSGWidget：

      • isDLSSSupported

API V2

以下是新的 Python 类：

  • vrdGpuStateInfo
  • vrdLinearGradient
  • vrdLinearGradientStop
  • vrdOpenVDBMaterial
  • vrdVolumeMaterial
  • vrdVolumeNode
  • vrdVolumeScatterMaterial
  • vrMaterialEntry

以下是对 API v2 所做的更改：

  • vrCameraService：

      • createViewpoint（返回值的文档已更改）

  • vrCameraTypes：

      • CameraSensorResponse 枚举中的新增内容：

  • CameraSensorResponse.AgX

  • CameraSensorResponse.AgX_Punchy

      • 新枚举：CameraSensorResponseCurveMapping
      • CameraColorspace 中的新增内容：

  • CameraColorspace.AgXColorspace

  • vrdAtfSettings：

      • 新函数：

  • getImportAnimations

  • getImportSwitchMaterials

  • getImportTextures

  • setImportAnimations

  • setImportSwitchMaterials

  • setImportTextures

  • vrdBaseLightNode：

      • setVolumeIlluminationMode：“mode”参数已记录

  • vrdDeviceInteraction：

      • createControllerAction（文档已更新）

  • vrdEnvironmentMaterial：

      • 新函数：

  • getIlluminateVolumes

  • setIlluminateVolumes

  • vrdGlassMaterial：

      • 新函数：

  • getIndexOfRefractionSpectrum

  • setIndexOfRefractionSpectrum

  • vrdSubsurfaceScattering：

      • 新函数：

  • getUseRoughness

  • setUseRoughness

  • vrdTonemapper：

      • 新函数：

  • getSensorResponseCurveMapping

  • setSensorResponseCurveMapping

      • getColorspace（返回值已更新）
      • setColorspace（参数 value 已更新）

  • vrGUIService：

      • 新信号：

  • recentFilesChanged

  • recentFilesCleared

  • vrHMDService：

      • 新函数：

  • getMixedRealityDepthEstimationEnabled

  • setMixedRealityDepthEstimationEnabled

  • vrNodeService：

      • initFindCache（文档已更新）

  • vrReferenceService

      • vrReferenceService.setUpdateMonitoringInterval(msecs)（文档已更新）

  • vrScenegraphService：

      • 新函数：

  • createVolume

  • vrScenegraphTypes：

      • 已添加到 NodeType 枚举：

  • VolumeNode

      • 新枚举：VolumeType

环境变量

我们对环境变量 VRED_DISABLE_ADP 进行了更改。现在，可以通过创建新的注册表项 HKEY_LOCAL_MACHINE\SOFTWARE\Autodesk\Privacy\TrustLevel(string value) 并将值设为 1 在计算机范围内禁用 ADP。

API v2 2024.2 中的新增功能

此页面介绍了在 VRED 2024.2 的 Python API v2 中新增和更改的内容（与 2024.1 相比）。

注意：

我们决定推迟发布 Python API v2，因为我们计划在 VRED 2025 中实施与体积渲染相关的各种更改和改进，这些更改和改进将对 API 产生影响。

Python 版本

Python 版本已更新至 3.11.6。

重要信息：

由于自 Python 3.11 起，负责将 Python 2 脚本自动更新为 Python 3 的库已弃用，因此我们建议您将这些脚本更新为 Python 3 以避免将来出现任何问题。

Qt 版本

Qt 已更新至 6.2.10。

新环境变量

以下是 2024.2 中的新环境变量：

  • VRED_CLUSTERSERVICE_CONFIG
  • VRED_CLUSTERSERVICE_DISABLE_ALL
  • VRED_CLUSTERSERVICE_ENABLE_ALL

移除的环境变量

我们移除了环境变量 STARVR_SDK。

API

下面汇总了新的函数、类和类型。

  • vrdBaseLightNode.getVolumeIlluminationMode() → vrLightTypes.VolumeIlluminationMode
  • vrdBaseLightNode.setVolumeIlluminationMode(mode)
  • vrLightTypes.VolumeIlluminationMode
  • vrdEnvironmentMaterial.getIlluminateVolumes() → bool
  • vrdEnvironmentMaterial.setIlluminateVolumes(value)
  • vrGPUService.gpuStateInfo() → List[vrdGpuStateInfo]
  • vrdGPUStateInfo
  • vrMaterialTypes.OpenVDBVolume
  • vrMaterialTypes.VolumeScatter

Python API V1 更改

以下是 2024.2 中的 Python API V1 更改：

  • vrMovieExport - 向 setCombinedChannelsRenderPasses 添加了参数 background_pass 和 volume_pass，并添加了以下函数：

    • getDepthMode
    • getDepthRange
    • setDepthMode
    • setDepthRange
    • setOcclusionRange
    • getOcclusionRange

  • vrOSGWidget - 添加了以下函数：

    • setActiveRenderPass - 添加了 VOLUME_COLOR_LAYER 参数
    • setDisplayMode - 移除了 VR_DISPLAY_VRHERO_XTAL

  • vrRenderSettings - 更改了以下函数：

    • setDenoiseAlpha - 已将参数更改为 denoiseAlpha
    • setRenderPasses - 向过程列表添加了 volume_color

Python API V2 更改

以下是 2024.2 中的 Python API V2 更改：

  • vrCADFileTypes - 进行以下更改：

    • 移除了 Maya
    • 添加了 SLP

  • vrdAtfSettings - 已将 Jt Open (Experimental) 重命名为 Jt Open（对于 getJtToolkit）

  • vrdBaseLightNode - 添加了以下内容：

    • getVolumeIlluminationMode
    • setVolumeIlluminationMode

  • vrdDeviceInteraction - 对以下类的文档进行了更改：

    • addSupportedInteractionGroup
    • createControllerAction
    • getControllerAction
    • removeControllerAction
    • removeSupportedInteractionGroup
    • setControllerActionMapping（包括已更改的 mapping 参数）
    • setSupportedInteractionGroups

  • vrDeviceService - 对以下类的文档进行了更改：

    • addBlockedDeviceModelOrSerial
    • createInteraction
    • getBlockedDeviceModelsOrSerials
    • getLeftTrackedHand
    • getRightTrackedHand
    • getVRDeviceBySerialNumber
    • isBlockedDeviceModelOrSerial
    • removeBlockedDeviceModelOrSerial
    • setBlockedDeviceModelsOrSerials
    • setTrackingOrigin
    • deviceCollisionStarted
    • deviceCollisionStopped
    • deviceMoved

  • vrdFileExportSettings - 已将文档添加到所有 SurfaceExportMode 枚举条目

  • 对于以下函数，已将参数 value 重命名为 enable，但下面提到的例外情况除外：

    • setExportAnimationClips
    • setExportAnimationCurves
    • setExportAnnotations
    • setExportCameras
    • setExportColors
    • setExportEnvironmentGeometries
    • setExportGeometrySwitches
    • setExportInvisibleData
    • setExportLightmaps
    • setExportLights
    • setExportMaterialSwitches
    • setExportMeshes
    • setExportMetadata
    • setExportSceneplates
    • setExportScripts
    • setExportSurfaces - 已将 value 参数重命名为 mode
    • setExportTouchSensors
    • setExportTransformVariants
    • setExportVariants
    • setExportVariantSets
    • setExportVertexColors
    • setFbxFormat - 已将 value 参数重命名为 format
    • setFbxVersionId - 已将 value 参数重命名为 id
    • setInlineTextures
    • setKeepEmptyGeometryNodes - 已将 value 参数重命名为 keep
    • setKeepEmptyGroupNodes - 已将 value 参数重命名为 keep
    • setKeepEmptyMaterialGroupNodes - 已将 value 参数重命名为 keep
    • setKeepEmptyShellNodes - 已将 value 参数重命名为 keep
    • setKeepUnusedMaterials - 已将 value 参数重命名为 keep
    • setRemoveBSides
    • setStlFormat

  • vrdVertexBakeSettings - 更新了 setIntensityThreshold 函数文档。

  • vrdVRDevice - 针对以下内容，对有关 OpenXR 模式的注释进行了更改：

    • addVirtualButton
    • disableRay
    • enableRay
    • getSerialNumber
    • getWristOrientationAngle
    • pick
    • removeVirtualButton - 适用于两种过载方法
    • setButtonPressed
    • setButtonTouched
    • setTrackingMatrix
    • signal
    • vibrate

  • vrFileIOService - 移除了以下信号：

    • addedGeometry

    • addLoadedMaterial

    • preExportGeometry

    • 将“cad”的拼写更改为“CAD”，将“vred”的拼写更改为“VRED”

    • 添加了 project 的文档

    • 更新了以下函数的文档：

      • checkCadType
      • getImageReadFilter
      • getImageReadFilter
      • importFiles

  • vrGPUService - 添加了 gpuStateInfo

  • vrGUIService - 已将 OpenVDB 值添加到 DialogType 枚举

  • vrHMDService - 移除了以下函数：

    • getStarVRRenderSettings
    • setStarVRRenderSettings

  • vrImmersiveInteractionService - 更改了 setViewpointMode 文档

  • vrLightTypes - 添加了枚举 VolumeIlluminationMode

  • vrMaterialTypes - 在 MaterialType 中添加了以下值：

    • VolumeScatter
    • OpenVDBVolume

已移除

我们移除了对 vrdStarVRRenderSettings 的支持。

API v2 2024.1 中的新增功能

用于导出节点的 Python

我们添加了用于导出节点的新方法。请参见 vrFileIoService、vrdFileExportSettings 和 vrdFileExportSettings::SurfaceExportMode。vrFileIOService 中添加了一些基本示例，展示了如何导入和导出文件以及如何更改这些设置。有关其他信息，请参见 vrdFileExportSettings 和 vrdFileExportSettings Example。

环境变量更新

我们修复了以下内容：

  • VRED_COLLABORATION_NO_UPLOAD - 修复了 ("uupload")
  • VRED_CURRENT_PROJECT_DIR - 删除了“_DIR'”之前的额外空格

我们添加了以下内容：

  • VRED_IMPORT_PERFORMANCE_LOG
  • VRED_SECURE_PYTHON
  • VRED_WORKSPACES_PATH

API V1 更新

vrCollision 添加了以下内容：

  • getCollidingNodes
  • getCollidingTriangleIndices
  • getCollidingTriangles
  • getCollisionInfo
  • getCollisionPoint

API V2 更新

我们添加了以下类：

  • vrdDisplacement
  • vrdFileExportSettings

我们更改了以下类：

  • 对 vrCADFileTypes 的更改：

    • CatiaV5 - 更新了注释以引用 V5
    • C3MF
    • IFC
    • SLP

  • 对 vrdAtfSettings 的更改：

    • getImportColors()
    • setImportColors()

  • 对 vrdMaterialXProperties 的更改：

    • 类描述中的代码示例已更新 (PySide2 -> PySide6)

  • 对 vrdMDLProperties 的更改：

    • 类描述中的代码示例已更新 (PySide2 -> PySide6)

  • 对 vrFileIOService 的更改：

    • 我们添加了以下内容：

    • abortJobs()

    • exportNodes()

    • getExportSettings()

    • getExportSettingsFromPreferences()

    • setExportSettings()

    • 我们移除了以下信号：

    • addedGeometry

    • addLoadedMaterial

    • importedFile

    • preExportGeometry

    • sequences

  • 对 vrGUIService 的更改：

    • openExportDialog()
    • openExportSceneDialog()

  • 对 vrLightService 的更改：

    • copyLights()
    • getLightsClipboard()
    • isLightsClipboardEmpty()
    • pasteLights()

  • 对 vrMaterialTypes 的更改：

    • MergeOptions

    • 对于 Default，文档已更改

    • 对于 IgnoreName，文档已更改

    • 对于 IncludeSwitchMaterials，文档已更改

    • 已添加 ExcludeXRiteMaterials

  • 对 vrQueryService 的更改：

    • 类文档已更新，并添加了代码示例

API v2 2024 中的新增功能

此页面介绍了在 VRED 的 Python API v2 2024 中新增和更改的内容（与 2023.4 相比）。

Python 版本

Python 版本已更新至 3.11.3。

  • 可以使用以下命令从 VRED 内打印 VRED 的 Python 版本：
print(sys.version)

Qt 版本

Qt 版本已从 Qt 5 更新至 6.2。其中，将 PySide 模块名称从 PySide2 更改为了 PySide6，并将 shiboken2 更改为了 shiboken6。

注意：

当选项“首选项”>“脚本”>“将脚本转换为当前 Python 版本”处于启用状态时，在 VRED 中执行 Python 脚本之前，名称 PySide2 和 shiboken2 将自动即时替换为 PySide6 和 shiboken6。

将应用程序从 PySide2 移植到 PySide6 - 可以使用以下命令从 VRED 内打印 VRED 的 Qt 版本： 

print(PySide6.QtCore.qVersion())

API

以下是新增的函数和类：

  • vrGUIService.getViewCubeOpacity() → float

  • vrGUIService.getViewCubePosition() → vrGUIService.ViewCubePosition

  • vrGUIService.getViewCubeSize() → vrGUIService.ViewCubeSize

  • vrGUIService.isNavBarVisible() → bool

  • vrGUIService.isViewCubeVisible() → bool

  • vrGUIService.setNavBarVisible(value)

  • vrGUIService.setViewCubeOpacity(value)

  • vrGUIService.setViewCubePosition(value)

  • vrGUIService.setViewCubeSize(value)

  • vrGUIService.setViewCubeVisible(value)

  • vrHMDService.getActiveOpenXRRuntimeName() → string

  • vrHMDService.getActiveOpenXRSystemName() → string

  • vrHMDService.getOpenXRDepthLayerCompositionEnabled

  • vrHMDService.setOpenXRDepthLayerCompositionEnabled(enable)

  • vrMaterialTypes.MDL

  • vrMaterialTypes.MaterialX

  • vrRoughnessTextureTypes

  • vrdMDLMaterial

  • vrdMaterialXMaterial

  • vrdRoughnessTexture.getRoughnessMapType() → vrRoughnessTextureTypes.ValueMapping

  • vrdRoughnessTexture.setRoughnessMapType(mapping)

新的材质粗糙度

在 VRED 2024 中，材质粗糙度更改为感知线性行为，且新值范围介于 0 和 1 之间。在先前 VRED 版本中，行为是非线性的，最大值为 40。将旧文件导入到 VRED 中时，材质粗糙度值会自动调整为新行为。

如果通过脚本明确设置具体的粗糙度值，例如使用 vrdPlasticMaterial.setRoughness(roughness)，则必须在脚本中调整值。

请参见此代码段进行转换：snippets/convertRoughness.py。

父页面: Python 文档