Python API Improvements (2023.3)

List of V1 API Changes

The following is a list of the Python command changes in the V1 API.

• vrAnimWidgets:

  • restoreAnimation has been deprecated

  • restoreAnimations has been deprecated

• vrOptimize:

  • removeMetadata was added

• vrRenderSettings:

  • The following are new added commands:

    • getDenoiseAlpha

    • setDenoiseAlpha

• vrScenegraph:

  • Basically, all functions have been marked as deprecated and have a pointer to the new function in the V2 API.

List of V2 API Changes

• vrAnnotationService:

  • The following are new added commands:

    • getSelection

    • setSelection

    • selectionChanged

• vrCameraService:

  • Changes were made to the class documentation

  • getCameras - The parameter name was changed

  • The following are new added commands:

    • getSelectedNodes

    • setSelectedNodes

    • zoomToNodes

    • selectionChanged

• vrdAtfSettings:

  • The following are new added commands:

    • getImportMetadata

    • setImportMetadata

• vrdCameraBaseNode:

  • isEqual - The documentation was updated

• vrdCameraCollider:

  • getEnabled - The documentation of return value changed

• vrdCameraNode:

  • The documentation on top of the class changed

• vrdDeltaLightNode:

  • The documentation on top of the class changed

• vrdDirectionalLightNode:

  • The documentation on top of the class changed

• vrdDiskLightNode:

  • The documentation on top of the class changed

• vrdEnvironmentRaytracingSettings:

  • The following are new added commands:

    • getAnisotropy

    • getFilterSampledCaustics

    • setAnisotropy

    • setFilterSampledCaustics

• vrdGeometryNode:

  • The following are new added commands:

    • isComponent

    • isMesh

    • isSurface

• vrdLensFlareGlow:

  • The documentation link in the class description was fixed

• vrdMaterialNode:

  • The documentation on top of the class changed

  • The following are new added commands:

    • getEnabled

    • setEnabled

• vrdNode:

  • The following are new added commands:

    • getIcon

    • getPath

    • getSelectableFlag

    • getSynchronizedNodes

    • getUniquePath

    • isImplicitShared

    • isSynchronized

    • setSelectableFlag

• vrdObject:

  • The following are new added commands:

    • isNull - The documentation was updated

    • isType - The documentation updated

• vrdPointLightNode:

  • Class documentation on top was added

• vrdRectangularLightNode:

  • The documentation on top of the class changed

• vrdSphericalLightNode:

  • The documentation on top of the class changed

• vrdSpotLightNode:

  • Class documentation on top was added

• vrdSwitchNode:

  • Class documentation on top was added

• vrdViewpointNode:

  • The documentation on top of the class changed

• vrFileIOService

  • The following are new added commands:

    • getWriteFileTypesFilter

    • isReadOnly

    • saveNodes

    • preQuit

• vrGeometryTypes:

  • VisibilityMergeMode has a new Enum class

• vrGUIService:

  • The following are new added commands:

    • openImportDialog

    • viewInNewRenderWindow

• vrImmersiveInteractionService:

  • getActiveHMDSupportsHandTracking was added

• vrMaterialService:

  • The following are new added commands:

    • getAllMaterialTags

    • getImportMetadata

    • getMaterials

    • setImportMetadata

• vrNodeService:

  • TraverseChoice has a new Enum class

  • findNode parameters changed

  • findNodes parameters changed

  • findNodes - A second findNodes function was added

  • The following are new added commands:

    • findNodeWithUniquePath

    • getAllNodes

    • getCloneRoot

    • getClones

    • getCommonParent

    • getMaxDepth

    • getNodesFromIds

    • getUniqueName

    • isInSubtree

    • traverse

• vrScenegraphTypes:

  • UnshareOption documentation was added to the Enum values

  • DuplicateOption has a new Enum class

  • Action has a new Enum class

  • ChangeFlag has a new enum class

  • NodeType has a new enum class

  • MirrorMode has a new enum class

• vrUVService:

  • The Python code example on top of the class was changed

• vrWebEngineService:

  • A typo in the Python code example was fixed

  • getWebEngine documentation was changed

New V2 API Classes

• vrAssetService
• vrdBillboardNode
• vrdClipPlaneNode
• vrdDistanceNode
• vrdEnvironmentNode
• vrdFindOptions
• vrdHostSwitchNode
• vrdMaterialPoolNode
• vrdMatrixTransformNode
• vrdMetadata
• vrdMetadataEntry
• vrdMetadataEntryList
• vrdMetadataSet
• vrdNodeInfo
• vrdSceneItemInfo
• vrdSoundNode
• vrdSoundObstructorNode
• vrdStereoSwitchNode
• vrdTessellationSettings
• vrGeometryService
• vrMetadataService
• vrMetadataTypes
• vrQueryService
• vrScenegraphService