Python API V2 の新機能

各リリースの VRED Python API v2 で追加および変更された機能について説明します。

[詳細を確認]アイコン Python サンドボックスおよびその他のセキュリティ情報については、「ソフトウェアのセキュリティ」を参照してください。

API v2 2024.2 の新機能

このページでは、2024.1 と比較して、VRED 2024.2 の Python API v2 で何が追加され、何が変更されたかを示します。

注:

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

これは、新しい関数、クラス、およびタイプの概要です。

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: getJtToolkit で Jt Open (Experimental) の名前を Jt Open に変更しました

  • 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 の例」を参照してください。

環境変数の更新

以下を修正しました。

  • 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 の更新

次のクラスを追加しました。

次のクラスを変更しました。

  • 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 の新機能

このページでは、2023.4 と比較して、VRED 2024 の Python API v2 で何が追加され、何が変更されたかを示します。

Python のバージョン

Python のバージョンが 3.11.3 に更新されました。VRED の Python バージョンは、VRED 内から次の方法でプリントできます。

print(sys.version)

Qt のバージョン

Qt のバージョンが Qt 5 から 6.2 に更新されました。これには、PySide のモジュール名が PySide2 から PySide6 に、shiboken2 から shiboken6 に変更されていることも含まれます。

注:

[基本設定] > [スクリプト] > [スクリプトを現在の Python バージョンに変換]オプションが有効である場合、PySide2 と shiboken2 の名前は、VRED で Python スクリプトを実行する前にオンザフライで PySide6 と shiboken6 に自動的に置き換えられます。

PySide2 から PySide6 にアプリケーションを移植する

VRED の Qt のバージョンは、VRED 内から次の方法でプリントできます。

print(PySide6.QtCore.qVersion())

API

新しい関数とクラスは次のとおりです。

新しいマテリアルの粗さ

VRED 2024 では、マテリアルの粗さが知覚的にリニアな動作に変更され、新しい値の範囲は 0 から 1 に変更されました。旧バージョンの VRED では、動作は非リニアで、最大値は 40 でした。VRED で古いファイルを読み込むと、マテリアルの粗さの値は新しい動作に合わせて自動的に調整されます。

特定の粗さの値をスクリプトを使用して明示的に設定する場合は(たとえば、vrdPlasticMaterial.setRoughness(roughness) など)、スクリプト内の値を調整する必要があります。

変換のためのスニペットについては、「snippets/convertRoughness.py」を参照してください。

親ページ: Python マニュアル