1. Epic GamesDeveloper
  3. UUsdConversionBlueprintLibrary

UUsdConversionBlueprintLibrary

Wrapped static conversion functions from the UsdUtilities module, so that they can be used via scripting

API > API/Plugins > API/Plugins/USDExporter

Inheritance Hierarchy

References

   
Module USDExporter
Header /Engine/Plugins/Importers/USDImporter/Source/USDExporter/Public/USDConversionBlueprintLibrary.h
Include #include "USDConversionBlueprintLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="UsdConversionLibrary"))  
class UUsdConversionBlueprintLibrary : public UBlueprintFunctionLibrary

Remarks

Wrapped static conversion functions from the UsdUtilities module, so that they can be used via scripting

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category void

AddPayload ( const FString& ReferencingStagePath,
const FString& ReferencingPrimPath,
const FString& TargetStagePath
)

  
Public function Static UFunction BlueprintCallable, Category void

AddReference ( const FString& ReferencingStagePath,
const FString& ReferencingPrimPath,
const FString& TargetStagePath
)

  
Public function Static UFunction BlueprintCallable, Category void  
Public function Static UFunction BlueprintCallable, Category bool

CanExportToLayer ( const FString& TargetFilePath
)

 Checks whether we can create a USD Layer with "TargetFilePath" as identifier and export to it
Public function Static UFunction BlueprintCallable, Category bool Returns true if we have prims that we can paste within our clipboard stage
Public function Static UFunction BlueprintCallable, Category bool

ClearMetadataField ( UUsdAssetUserData* AssetUserData,
const FString& Key,
const FString& StageIdentifier,
const FString& PrimPath,
bool bTriggerPropertyChangeEvents
)

  
Public function Static UFunction BlueprintCallable, Category void Clears all prims from our clipboard stage
Public function Static UFunction BlueprintCallable, Category bool

CopyPrims ( const FString& StageRootLayer,
const TArray< FString >& PrimPaths
)

 Copies flattened versions of the input prims onto the clipboard stage.
Public function Static UFunction BlueprintCallable, Category bool

CutPrims ( const FString& StageRootLayer,
const TArray< FString >& PrimPaths
)

 Copies flattened versions of the input prims onto the clipboard stage and removes all the prim specs for Prims from their stages.
Public function Static UFunction BlueprintCallable, Category TArray< FString >

DuplicatePrims ( const FString& StageRootLayer,
const TArray< FString >& PrimPaths,
EUsdDuplicateType DuplicateType,
const FString& TargetLayer
)

 Duplicates all provided Prims one-by-one, performing the requested DuplicateType.
Public function Static UFunction BlueprintCallable, Category FString

GenerateObjectVersionString ( const UObject* ObjectToExport,
UObject* ExportOptions
)

 Generates a unique identifier string that involves ObjectToExport's package's persistent guid, the corresponding file save date and time, and the number of times the package has been dirtied since last being saved.
Public function Static UFunction BlueprintCallable, Category TSet< AActor * >  
Public function Static UFunction BlueprintCallable, Category TArray< FAnalyticsEventAttr > Retrieves the analytics attributes to send for the provided options object
Public function Static UFunction BlueprintCallable, Category AInstancedFoliageActor *

GetInstancedFoliageActorForLevel ( bool bCreateIfNone,
ULevel* Level
)

 Wraps AInstancedFoliageActor::GetInstancedFoliageActorForLevel, and allows retrieving the current AInstancedFoliageActor for a level.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FTransform >

GetInstanceTransforms ( AInstancedFoliageActor* Actor,
UFoliageType* FoliageType,
ULevel* InstancesLevel
)

 Returns the transforms of all instances of a particular UFoliageType on a given level.
Public function Static UFunction BlueprintCallable, Category TArray< FString > Returns the path name (e.g. "/Game/Maps/MyLevel") of levels that are loaded on `World_.
Public function Static UFunction BlueprintCallable, Category FUsdMetadataValue

GetMetadataField ( UUsdAssetUserData* AssetUserData,
const FString& Key,
const FString& StageIdentifier,
const FString& PrimPath
)

  
Public function Static UFunction BlueprintCallable, Category int32

GetNumLevelsToExport ( UWorld* World,
const TSet< FString >& LevelsToIgnore
)

 Returns how many total Unreal levels (persistent + all sublevels) will be exported if we consider LevelsToIgnore
Public function Static UFunction BlueprintCallable, Category FString

GetPrimPathForObject ( const UObject* ActorOrComponent,
const FString& ParentPrimPath,
bool bUseActorFolders
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category, Meta UObject *

GetSource ( UFoliageType* FoliageType
)

 Returns the source asset for a UFoliageType.
Public function Static UFunction BlueprintCallable, Category UUsdAssetUserData * Retrieve the first instance of UUsdAssetUserData contained on the Object, if any
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UFoliageType * > Returns all the different types of UFoliageType assets that a particular AInstancedFoliageActor uses.
Public function Static UFunction BlueprintCallable, Category TArray< FString > Returns the path name (e.g. "/Game/Maps/MyLevel") of levels that checked to be visible in the editor within `World_.
Public function Static UFunction BlueprintCallable, Category bool

HasMetadataField ( UUsdAssetUserData* AssetUserData,
const FString& Key,
const FString& StageIdentifier,
const FString& PrimPath
)

  
Public function Static UFunction BlueprintCallable, Category void

InsertSubLayer ( const FString& ParentLayerPath,
const FString& SubLayerPath,
int32 Index
)

  
Public function Static UFunction BlueprintCallable, Category FString

MakePathRelativeToLayer ( const FString& AnchorLayerPath,
const FString& PathToMakeRelative
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FString >

PastePrims ( const FString& StageRootLayer,
const FString& ParentPrimPath
)

 Pastes the prims from the clipboard stage as children of ParentPrim.
Public function Static UFunction BlueprintCallable, Category void If we used `ReverseSequencerAnimations_ to undo the effect of an opened sequencer before export, this function can be used to re-apply the sequencer state back to the level after the export is complete
Public function Static UFunction BlueprintCallable, Category void

RemoveAllPrimSpecs ( const FString& StageRootLayer,
const FString& PrimPath,
const FString& TargetLayer
)

 Removes all the prim specs for Prim on the given Layer.
Public function Static UFunction BlueprintCallable, Category void  
Public function Static UFunction BlueprintCallable, Category void If we have the Sequencer open with a level sequence animating the level before export, this function can revert any actor or component to its unanimated state
Public function Static UFunction BlueprintCallable, Category void

SendAnalytics ( const TArray< FAnalyticsEventAttr >& Attrs,
const FString& EventName,
bool bAutomated,
double ElapsedSeconds,
double NumberOfFrames,
const FString& Extension
)

 Defer to the USDClasses module to actually send analytics information
Public function Static UFunction BlueprintCallable, Category bool

SetMetadataField ( UUsdAssetUserData* AssetUserData,
const FString& Key,
const FString& Value,
const FString& ValueTypeName,
const FString& StageIdentifier,
const FString& PrimPath,
bool bTriggerPropertyChangeEvents
)

 Utilities that make it easier to get/set metadata fields without having to manipulate the nested struct instances directly.
Public function Static UFunction BlueprintCallable, Category bool

SetUsdAssetUserData ( UObject* Object,
UUsdAssetUserData* AssetUserData
)

 Sets AssetUserData as the single UUsdAssetUserData on the Object, overwriting an existing one if encountered.
Public function Static UFunction BlueprintCallable, Category void

StreamInRequiredLevels ( UWorld* World,
const TSet< FString >& LevelsToIgnore
)

 Fully streams in and displays all levels whose names are not in LevelsToIgnore
Public function Static UFunction BlueprintCallable, Category void

StreamOutLevels ( UWorld* OwningWorld,
const TArray< FString >& LevelNamesToStreamOut,
const TArray< FString >& LevelNamesToHide
)

 Streams out/hides sublevels that were streamed in before export
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsAssetPath ( const FString& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsBool ( bool Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsBoolArray ( const TArray< bool >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDouble ( double Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDouble2 ( const FVector2D& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDouble3 ( const FVector& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDouble3Array ( const TArray< FVector >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDouble4 ( const FVector4& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsDoubleArray ( const TArray< double >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat ( float Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat2 ( const FVector2D& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat3 ( const FVector& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat3Array ( const TArray< FVector >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat4 ( const FVector4& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloat4Array ( const TArray< FVector4 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsFloatArray ( const TArray< float >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf ( float Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf2 ( const FVector2D& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf2Array ( const TArray< FVector2D >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf3 ( const FVector& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf3Array ( const TArray< FVector >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf4 ( const FVector4& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalf4Array ( const TArray< FVector4 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsHalfArray ( const TArray< float >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt ( int32 Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt2 ( const FIntPoint& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt2Array ( const TArray< FIntPoint >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt3 ( const FIntVector& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt3Array ( const TArray< FIntVector >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt4 ( const FIntVector4& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsInt64Array ( const TArray< int64 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsIntArray ( const TArray< int32 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsListOpTokens ( const TArray< FString >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsMatrix2d ( const FMatrix2D& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsMatrix3d ( const FMatrix3D& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsMatrix4d ( const FMatrix& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuatd ( const FQuat& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuatdArray ( const TArray< FQuat >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuatf ( const FQuat& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuatfArray ( const TArray< FQuat >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuath ( const FQuat& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsQuathArray ( const TArray< FQuat >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsString ( const FString& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsStringArray ( const TArray< FString >& Value
)

  
Public function Static UFunction BlueprintCallable, Category, Meta FString

StringifyAsTimeCode ( double Value
)

  
Public function Static UFunction BlueprintCallable, Category, Meta FString

StringifyAsTimeCodeArray ( const TArray< double >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsToken ( const FString& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

StringifyAsTokenArray ( const TArray< FString >& Value
)

  
Public function Static UFunction BlueprintCallable, Category, Meta FString  
Public function Static UFunction BlueprintCallable, Category, Meta FString

StringifyAsUCharArray ( const TArray< uint8 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category, Meta FString  
Public function Static UFunction BlueprintCallable, Category, Meta FString  
Public function Static UFunction BlueprintCallable, Category, Meta FString

StringifyAsUInt64Array ( const TArray< int64 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category, Meta FString

StringifyAsUIntArray ( const TArray< int32 >& Value
)

  
Public function Static UFunction BlueprintCallable, Category FString

UnstringifyAsAssetPath ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FString >  
Public function Static UFunction BlueprintCallable, Category bool

UnstringifyAsBool ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< bool >

UnstringifyAsBoolArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category double

UnstringifyAsDouble ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector2D

UnstringifyAsDouble2 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector2D >  
Public function Static UFunction BlueprintCallable, Category FVector

UnstringifyAsDouble3 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector >  
Public function Static UFunction BlueprintCallable, Category FVector4

UnstringifyAsDouble4 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector4 >  
Public function Static UFunction BlueprintCallable, Category TArray< double >

UnstringifyAsDoubleArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category float

UnstringifyAsFloat ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector2D

UnstringifyAsFloat2 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector2D >

UnstringifyAsFloat2Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector

UnstringifyAsFloat3 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector >

UnstringifyAsFloat3Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector4

UnstringifyAsFloat4 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector4 >

UnstringifyAsFloat4Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< float >

UnstringifyAsFloatArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category float

UnstringifyAsHalf ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector2D

UnstringifyAsHalf2 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector2D >

UnstringifyAsHalf2Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector

UnstringifyAsHalf3 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector >

UnstringifyAsHalf3Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FVector4

UnstringifyAsHalf4 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FVector4 >

UnstringifyAsHalf4Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< float >

UnstringifyAsHalfArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category int32

UnstringifyAsInt ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FIntPoint

UnstringifyAsInt2 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FIntPoint >

UnstringifyAsInt2Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FIntVector

UnstringifyAsInt3 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FIntVector >

UnstringifyAsInt3Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FIntVector4

UnstringifyAsInt4 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FIntVector4 >

UnstringifyAsInt4Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category int64

UnstringifyAsInt64 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< int64 >

UnstringifyAsInt64Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< int32 >

UnstringifyAsIntArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FString >  
Public function Static UFunction BlueprintCallable, Category FMatrix2D

UnstringifyAsMatrix2d ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FMatrix2D >  
Public function Static UFunction BlueprintCallable, Category FMatrix3D

UnstringifyAsMatrix3d ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FMatrix3D >  
Public function Static UFunction BlueprintCallable, Category FMatrix

UnstringifyAsMatrix4d ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FMatrix >  
Public function Static UFunction BlueprintCallable, Category FQuat

UnstringifyAsQuatd ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FQuat >

UnstringifyAsQuatdArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FQuat

UnstringifyAsQuatf ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FQuat >

UnstringifyAsQuatfArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FQuat

UnstringifyAsQuath ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FQuat >

UnstringifyAsQuathArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category FString

UnstringifyAsString ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FString >

UnstringifyAsStringArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta double

UnstringifyAsTimeCode ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< double >  
Public function Static UFunction BlueprintCallable, Category FString

UnstringifyAsToken ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category TArray< FString >

UnstringifyAsTokenArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta uint8

UnstringifyAsUChar ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< uint8 >

UnstringifyAsUCharArray ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int32

UnstringifyAsUInt ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int64

UnstringifyAsUInt64 ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< int64 >

UnstringifyAsUInt64Array ( const FString& String
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< int32 >

UnstringifyAsUIntArray ( const FString& String
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page