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&40;Meta&61;&40;ScriptName&61;"UsdConversionLibrary"&41;&41;  
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 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 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 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, 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 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 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 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page