1. Epic GamesDeveloper
  3. UnrealUSDWrapper

UnrealUSDWrapper

API > API/Plugins > API/Plugins/UnrealUSDWrapper

References

   
Module UnrealUSDWrapper
Header /Engine/Plugins/Runtime/USDCore/Source/UnrealUSDWrapper/Public/UnrealUSDWrapper.h
Include #include "UnrealUSDWrapper.h"

Syntax

class UnrealUSDWrapper

Functions

  Type Name Description
Public function Static void

AddUsdExportFileFormatDescriptions ( TArray< FString >& OutFormatExtensions,
TArray< FString >& OutFormatDescriptions
)

 Internally used by all the export factories, this will query the supported export USD file formats and fill out OutFormatExtensions with entries like "usd", "usda", "usdc", etc., and OutFormatDescriptions with entries like "Universal Scene Description binary file" or "Universal Scene Description text file"
Public function Static void Internally used by all the import factories, this will query the supported export USD file formats and fill out OutFormats with entries like "usda; Universal Scene Description text files", "usdc; Universal Scene Description binary files", etc.
Public function Static void Stops listening to error/warning/log messages emitted by USD
Public function Static void

EraseStageFromCache ( const UE::FUsdStage& Stage
)

 Removes the stage from the stage cache. See UsdStageCache::Erase.
Public function Static TArray< UE::FUsdStage > Returns all the stages that are currently opened in the USD utils stage cache, shared between C++ and Python
Public function Static TArray< FString > Returns the file extensions of all file formats supported by USD.
Public function Static UE::FUsdStage Get the singleton, persistent stage used as a clipboard for prim cut/copy/paste operations.
Public function Static void

GetNativeFileFormats ( TArray< FString >& OutTextFormats,
TArray< FString >& OutPossiblyBinaryFormats
)

  
Public function Static TArray< FString > Returns the file extensions that are native to USD.
Public function Static UE::FUsdStage Creates a new memory USD root layer, opens it as a new stage and returns that stage
Public function Static UE::FUsdStage

NewStage ( const TCHAR* FilePath
)

 Creates a new USD root layer file, opens it as a new stage and returns that stage
Public function Static UE::FUsdStage

OpenMaskedStage ( const TCHAR* Identifier,
EUsdInitialLoadSet InitialLoadSet,
const TArray< FString >& PopulationMask,
bool bForceReloadLayersFromDisk
)

  
Public function Static UE::FUsdStage

OpenMaskedStage ( UE::FSdfLayer RootLayer,
UE::FSdfLayer SessionLayer,
EUsdInitialLoadSet InitialLoadSet,
const TArray< FString >& PopulationMask,
bool bForceReloadLayersFromDisk
)

  
Public function Static UE::FUsdStage

OpenStage ( const TCHAR* Identifier,
EUsdInitialLoadSet InitialLoadSet,
bool bUseStageCache,
bool bForceReloadLayersFromDisk
)

 Opens a USD stage from a file on disk or existing layers, with a population mask or not.
Public function Static UE::FUsdStage

OpenStage ( UE::FSdfLayer RootLayer,
UE::FSdfLayer SessionLayer,
EUsdInitialLoadSet InitialLoadSet,
bool bUseStageCache,
bool bForceReloadLayersFromDisk
)

  
Public function Static TArray< FString >

RegisterPlugins ( const FString& PathToPlugInfo
)

 Registers all USD plug-ins discovered at PathToPlugInfo.
Public function Static TArray< FString >

RegisterPlugins ( const TArray< FString >& PathsToPlugInfo
)

 Registers all USD plug-ins discovered in any of PathsToPlugInfo.
Public function Static void Set the directories that will be used as the default search path by USD's default resolver during asset resolution.
Public function Static void Starts listening to error/warning/log messages emitted by USD

Constants

Name Description
Delegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page