NEW What's New in Python API V1 and V2

Find what was added and changed in the VRED Python API v2 for each release.

learnMore icon For information on the Python Sandbox and other security information, see Software Security.

What's New in API v1 and v2 2025.3

Python Examples

Added the following Python examnples:

  • Under Physics Examples, we added Physics Save and Load Example, which demonstrates how collision data can be made persistent.

  • Under Snippets, we added these toolbar examples:

    • toolbar1 demonstrates how to add a custom icon to the VRED Toolbar.
    • toolbar2 demonstrates how to add a custom icon with a submenu to the VRED Toolbar.

API V1

The following functions were removed from vrMovieExportModule:

  • getOptimizationMode
  • getRenderingColorspace
  • setOptimizationMode
  • setRenderingColorspace

The following functions were added to vrRenderSettings:

  • getOptimizationMode
  • getRenderingColorspace
  • setOptimizationMode
  • setRenderingColorspace

For vrSceneGraph, the parameter was changed for fixDepthOfField.

API V2

Added the following new classes in 2025.3:

  • vrdGPUInfo
  • vrdGradingLut
  • vrdGradingPrimary
  • vrdGradingRGBMCurve
  • vrdGradingTone

Added the following new enum values:

  • vrCameraTypes
    • CameraSensorResponse.OpenColorIO
    • PasteOption.PasteGradingAttributes
    • new enum: GradingLogSpace

Removed the DataTranslator enum from vrdAtfSettings and removed the getDataTranslator and setDataTranslator functions.

Added the following functions to vrdCameraBaseNode:

  • getGradingEnabled
  • getGradingLut
  • getGradingPresetFilename
  • getGradingPresetFolder
  • getGradingPrimary
  • getGradingRGBCurve
  • getGradingTone
  • isGradingPresetModified
  • loadGradingPreset
  • saveGradingPreset
  • setGradingEnabled

Added the following functions to vrdTonemapper:

  • estimateWhitebalanceFromPixel
  • getHdrView
  • getLook
  • getView
  • setHdrView
  • setLook
  • setView

Added the following functions to vrGUIService:

  • addMainWindowToolBar
  • removeMainWindowToolBar

For the following class, we changed the documentation:

  • vrNodeService

    • findNodes(names, wildcard, includeComponents, root, caseSensitive) → List[vrdNode]

  • vrDeviceService

    • addBlockedDeviceModelOrSerial
    • getBlockedDeviceModelsOrSerials
    • isBlockedDeviceModelOrSerial
    • removeBlockedDeviceModelOrSerial
    • setBlockedDeviceModelsOrSerials
    • deviceCollisionStarted
    • deviceCollisionStopped
    • deviceMoved

  • vrdProjectMergeSettings

    • getEnvironmentImportOption
    • setEnvironmentImportOption

  • vrdVRDevice

    • disableRay
    • enableRay
    • getSerialNumber
    • pick
    • signal
    • vibrate

  • vrMetadataService

    • getScenegraphTags

  • vrPhysicsService

    • clearCollisionData
    • hasCollisionData

Added the cleared signal to vrUndoService.

What's New in API v1 and v2 2025.2

Environment Variables

Added VRED_FORCE_HTTPS. When set to 1, it enables this option, redirecting incoming unencrypted (http) connection requests to encrypted (https) connection requests in the VRED web interface. Encrypted HTTPS Only is greyed out in the preferences and cannot to changed through the UI. When set to 0, it uses the Encrypted HTTPS Only preference option setting.

Python Examples

Added the following Python examnples:

  • Under Other Script Plugins > vrDragAndDropExample
  • Under Snippets > vr_terminal

API V1

The following functions were added to these classes:

  • vrRenderSettings

    • getOptimizationMode
    • setOptimizationMode
    • getRenderingColorspace
    • setRenderingColorspace

  • vrMovieExport

    • getOptimizationMode
    • setOptimizationMode
    • getRenderingColorspace
    • setRenderingColorspace

  • vrNodeUtils

    • setIsVRNode

  • vrRenderSettings

    • getRaytracingPhotonUseAutomaticRadius

  • vrScenegraph

    • fixDepthOfField

API V2

Added the following new classes in 2025.2:

  • vrMaterialEntryType
  • vrUserMimeTypes

Added the following functions to these classes in 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

Added the return types, CameraSensorResponse and AgX_Custom to vrCameraTypes.

For the following class, we added these new signals:

  • vrAnnotationService

    • annotationGraphChanged

  • vrFileIOService

    • projectReadyToRender

For these classes, the following have changed:

  • vrAnnotationService

    • createAnnotation

  • vrdVRDevice

    • getSerialNumber

  • vrDeviceService

    • setBlockedDeviceModelsOrSerials
    • getBlockedDeviceModelsOrSerials
    • addBlockedDeviceModelOrSerial
    • removeBlockedDeviceModelOrSerial
    • isBlockedDeviceModelOrSerial

What's New in API v1 and v2 2025.1

Environment Variables

Changed the description for VRED_DISABLE_ADP.

Python Examples

Added a new Physics section with two examples and added a steering wheel example to the Constraints section.

API V1

Changes have been made to the following. Visit the Python API V1 section for specifics.

For vrAnimWidgets, the parameters and return value for addTranslationControlPoint have changed and addTranslationControlPoints (same) has changed.

For these classes, the following have changed:

  • vrCamera

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

  • vrConnector - setConnectorMousePos changed

  • vrInteraction

    • getUseBoundingboxesForInteractionInVR
    • setUseBoundingboxesForInteractionInVR.

  • vrMaterialPtr - setTextureTransform changed

  • vrNodeUtils - unshareCores changed

  • vrOSGWidget

    • getSuperSampling
    • setSuperSampling
    • setSuperSamplingOnCameraMovement
    • setSuperSamplingQuality
    • getSuperSamplingQuality

  • vrRenderSettings - setRenderVariantSets changed

  • vrScenegraph - cloneNodes changed

  • For vrSequencer, the following have changed:

    • readSequenceXML
    • runSequenceHttp

  • vrVariants - createAndCaptureVariantSet changed

  • vrVariantSetPtr - addClippingPlane changed

  • vrVredUi - getMainWindow changed

  • vrWebOverlay - setFrame changed

For vrMaterialEditor, the documenmtation for enableSubstancePresetCache has changed.

API V2

We added the following classes to the Python API V2:

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

We added these functions to the following:

  • vrdFileExportSettings

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

  • vrdAtfSettings

    • ModelState enum
    • getModelState
    • setModelState

  • vrdNode added isSynchronizedWith

  • vrdViewpointNode added removePreview

  • vrFileTypes added TextureCompressionMode enum

  • vrImmersiveInteractionService

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

For vrdSubstanceMaterial, we added an example to the class documentation.

We made these changes to the following functions:

  • vrdAtfSettings

    • getUseLegacyLoader()
    • setUseLegacyLoader().

  • vrdGeometryNode

    • getNormals
    • getPositions
    • getTexCoords
    • setNormals
    • setPositions

  • vrMaterialService

    • getMaterialFromId

  • vrReferenceService

    • setUpdateMonitoringInterval

We removed getSRgbMidColorPosition and setSRgbMidColorPosition from vrdLinearGradientStop.

Some classes in the following have been changed to enum values. Visit the Python API V2 section for specifics.

  • 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

What's New in API v1 and v2 2025

API V1

These are the new Python classes:

  • vrMovieExport:

      • getOcclusionRange

  • vrOSGWidget:

      • isDLSSSupported

API V2

These are the new Python classes:

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

These are the changes made to API v2:

  • vrCameraService:

      • createViewpoint (documentation of return value changed)

  • vrCameraTypes:

      • New in the CameraSensorResponse Enum:

  • CameraSensorResponse.AgX

  • CameraSensorResponse.AgX_Punchy

      • New Enum: CameraSensorResponseCurveMapping
      • New in CameraColorspace:

  • CameraColorspace.AgXColorspace

  • vrdAtfSettings:

      • New functions:

  • getImportAnimations

  • getImportSwitchMaterials

  • getImportTextures

  • setImportAnimations

  • setImportSwitchMaterials

  • setImportTextures

  • vrdBaseLightNode:

      • setVolumeIlluminationMode: 'mode' parameter has been documented

  • vrdDeviceInteraction:

      • createControllerAction (documentation updated)

  • vrdEnvironmentMaterial:

      • New functions:

  • getIlluminateVolumes

  • setIlluminateVolumes

  • vrdGlassMaterial:

      • New functions:

  • getIndexOfRefractionSpectrum

  • setIndexOfRefractionSpectrum

  • vrdSubsurfaceScattering:

      • New functions:

  • getUseRoughness

  • setUseRoughness

  • vrdTonemapper:

      • New functions:

  • getSensorResponseCurveMapping

  • setSensorResponseCurveMapping

      • getColorspace (return value updated)
      • setColorspace (parameter value updated)

  • vrGUIService:

      • New signals:

  • recentFilesChanged

  • recentFilesCleared

  • vrHMDService:

      • New functions:

  • getMixedRealityDepthEstimationEnabled

  • setMixedRealityDepthEstimationEnabled

  • vrNodeService:

      • initFindCache (documentation updated)

  • vrReferenceService

      • vrReferenceService.setUpdateMonitoringInterval(msecs) (documentation updated)

  • vrScenegraphService:

      • New functions:

  • createVolume

  • vrScenegraphTypes:

      • Added to the NodeType Enum:

  • VolumeNode

      • New Enum: VolumeType

Environment Variables

We made a change to the environment variable VRED_DISABLE_ADP. ADP can now be disabled machine-wide by creating a new registry key, HKEY_LOCAL_MACHINE\SOFTWARE\Autodesk\Privacy\TrustLevel(string value), with a value of 1.

What's New in API v2 2024.2

This page shows what was added to and changed in the Python API v2 in VRED 2024.2, compared to 2024.1.

Note:

We have decided to postpone the release of the Python API v2, due to our plans to implement various changes and improvements related to Volume Rendering with VRED 2025 that will have an impact on the API.

Python Version

The Python version was updated to 3.11.6.

Important:

Since the library responsible for automatically updating Python 2 scripts to Python 3 has been deprecated as of Python 3.11, we recommend you update these scripts to Python 3 to avoid any future problems.

Qt Version

Qt has been updated to 6.2.10.

New Environment Variables

These are the new environment variables in 2024.2:

  • VRED_CLUSTERSERVICE_CONFIG
  • VRED_CLUSTERSERVICE_DISABLE_ALL
  • VRED_CLUSTERSERVICE_ENABLE_ALL

Removed Environment Variables

We removed the environment variable, STARVR_SDK.

API

This is a summary of the new functions, classes, and types.

  • 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 Changes

These are the Python API V1 changes found in 2024.2:

  • vrMovieExport - added the parameters background_pass and volume_pass to setCombinedChannelsRenderPasses, and added the following functions:

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

  • vrOSGWidget - added the following functions:

    • setActiveRenderPass - added VOLUME_COLOR_LAYER parameters
    • setDisplayMode - removed VR_DISPLAY_VRHERO_XTAL

  • vrRenderSettings - changed the following functions:

    • setDenoiseAlpha - changed the parameter to denoiseAlpha
    • setRenderPasses - added volume_color to the list of passes

Python API V2 Changes

These are the Python API V2 changes found in 2024.2:

  • vrCADFileTypes - made the following changes:

    • Maya was removed
    • SLP was added

  • vrdAtfSettings - renamed Jt Open (Experimental) to Jt Open for getJtToolkit

  • vrdBaseLightNode - added the following:

    • getVolumeIlluminationMode
    • setVolumeIlluminationMode

  • vrdDeviceInteraction- made changes to the documentation for the following classes:

    • addSupportedInteractionGroup
    • createControllerAction
    • getControllerAction
    • removeControllerAction
    • removeSupportedInteractionGroup
    • setControllerActionMapping (including the mapping parameter that changed)
    • setSupportedInteractionGroups

  • vrDeviceService - made changes to the documentation for the following classes:

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

  • vrdFileExportSettings - added documentation to all SurfaceExportMode enum entries

  • Renamed the parameter value to enable, with any exceptions noted below, for the following functions:

    • setExportAnimationClips
    • setExportAnimationCurves
    • setExportAnnotations
    • setExportCameras
    • setExportColors
    • setExportEnvironmentGeometries
    • setExportGeometrySwitches
    • setExportInvisibleData
    • setExportLightmaps
    • setExportLights
    • setExportMaterialSwitches
    • setExportMeshes
    • setExportMetadata
    • setExportSceneplates
    • setExportScripts
    • setExportSurfaces - renamed the value parameter to mode
    • setExportTouchSensors
    • setExportTransformVariants
    • setExportVariants
    • setExportVariantSets
    • setExportVertexColors
    • setFbxFormat - renamed the value parameter to format
    • setFbxVersionId - renamed the value parameter to id
    • setInlineTextures
    • setKeepEmptyGeometryNodes - renamed the value parameter to keep
    • setKeepEmptyGroupNodes - renamed the value parameter to keep
    • setKeepEmptyMaterialGroupNodes - renamed the value parameter to keep
    • setKeepEmptyShellNodes - renamed the value parameter to keep
    • setKeepUnusedMaterials - renamed the value parameter to keep
    • setRemoveBSides
    • setStlFormat

  • vrdVertexBakeSettings - updated the setIntensityThreshold function documentation.

  • vrdVRDevice - made changes to the note, regarding the OpenXR mode, for the following:

    • addVirtualButton
    • disableRay
    • enableRay
    • getSerialNumber
    • getWristOrientationAngle
    • pick
    • removeVirtualButton - for both overloaded methods
    • setButtonPressed
    • setButtonTouched
    • setTrackingMatrix
    • signal
    • vibrate

  • vrFileIOService - removed the following signals:

    • addedGeometry

    • addLoadedMaterial

    • preExportGeometry

    • changed the spelling of 'cad' to 'CAD' and 'vred'to 'VRED'

    • added documentation for project

    • updated the documentation for the following functions:

      • checkCadType
      • getImageReadFilter
      • getImageReadFilter
      • importFiles

  • vrGPUService - added gpuStateInfo

  • vrGUIService - added the OpenVDB value to the DialogType enum

  • vrHMDService - removed the following functions:

    • getStarVRRenderSettings
    • setStarVRRenderSettings

  • vrImmersiveInteractionService - changed the setViewpointMode documentation

  • vrLightTypes - added the enum VolumeIlluminationMode

  • vrMaterialTypes - added the following values in MaterialType:

    • VolumeScatter
    • OpenVDBVolume

Removed

We removed support for vrdStarVRRenderSettings.

What's New in API v2 2024.1

Python for Exporting Nodes

We added new methods for exporting nodes. Look at vrFileIoService, vrdFileExportSettings, and vrdFileExportSettings::SurfaceExportMode. Some basic examples have been added to vrFileIOService showing how to import and export files, as well as how to change these settings. See vrdFileExportSettings and vrdFileExportSettings Example for additional information.

Environment Variable Updates

We fixed the following:

  • VRED_COLLABORATION_NO_UPLOAD - fixed ("uupload")
  • VRED_CURRENT_PROJECT_DIR - removed the extra space before '_DIR"

We added the following:

  • VRED_IMPORT_PERFORMANCE_LOG
  • VRED_SECURE_PYTHON
  • VRED_WORKSPACES_PATH

API V1 Updates

We added the following to vrCollision:

  • getCollidingNodes
  • getCollidingTriangleIndices
  • getCollidingTriangles
  • getCollisionInfo
  • getCollisionPoint

API V2 Updates

We added the following classes:

  • vrdDisplacement
  • vrdFileExportSettings

We changed these classes:

  • Changes to vrCADFileTypes:

    • CatiaV5 - Updated the comment to refer to V5
    • C3MF
    • IFC
    • SLP

  • Changes to vrdAtfSettings:

    • getImportColors()
    • setImportColors()

  • Changes to vrdMaterialXProperties:

    • The code example in the class description was updated (PySide2 -> PySide6)

  • Changes to vrdMDLProperties:

    • The code example in the class description was updated (PySide2 -> PySide6)

  • Changes to vrFileIOService:

    • We added the following:

    • abortJobs()

    • exportNodes()

    • getExportSettings()

    • getExportSettingsFromPreferences()

    • setExportSettings()

      • We removed the following signals:

    • addedGeometry

    • addLoadedMaterial

    • importedFile

    • preExportGeometry

    • sequences

  • Changes to vrGUIService:

    • openExportDialog()
    • openExportSceneDialog()

  • Changes to vrLightService:

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

  • Changes to vrMaterialTypes:

    • MergeOptions
    • For Default, the documentation changed
    • For IgnoreName, the documentation changed
    • For IncludeSwitchMaterials, the documentation changed
    • Added ExcludeXRiteMaterials

  • Changes to vrQueryService:

    • The class documentation was updated and a code example was added

What's New in API v2 2024

This page shows what was added to and changed in the Python API v2 in VRED 2024, compared to 2023.4.

Python Version

The Python version was updated to 3.11.3.`

  • `VRED’s Python version can be printed from within VRED with:
print(sys.version)

Qt Version

The Qt version was updated from Qt 5 to 6.2. This includes that the PySide module name changes from PySide2 to PySide6, and shiboken2 to shiboken6.

Note:

When option “Preferences > Script > Translate script to current Python version” is enabled, the names PySide2 and shiboken2 are automatically replaced by PySide6 and shiboken6 on the fly before executing Python scripts in VRED.

Porting Applications from PySide2 to PySide6 ` - `VRED’s Qt version can be printed from within VRED with: 

print(PySide6.QtCore.qVersion())

API

These are the new functions and classes:

  • 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)

New Material Roughness

In VRED 2024, the material roughness is changed to a perceptually linear behavior and a new value range between 0 and 1. In older VRED versions, the behavior was non-linear and the maximum value was 40. When importing older files into VRED, material roughness values are automatically adjusted to the new behavior.

In case you set specific roughness values explicitly via script, for example with vrdPlasticMaterial.setRoughness(roughness), you must adjust the value in the script.

See this snippet for the conversion: snippets/convertRoughness.py.

Parent page: Python Documentation