1. Epic GamesDeveloper
  3. UUsdConversionBlueprintContext

UUsdConversionBlueprintContext

Wraps the UnrealToUsd component conversion functions from the USDUtilities module so that they can be used by scripting languages.

API > API/Plugins > API/Plugins/USDExporter

Wraps the UnrealToUsd component conversion functions from the USDUtilities module so that they can be used by scripting languages.

This is an instanceable object instead of just static functions so that the USDStage to use for the conversions can be provided and cached between function calls, which is helpful because we're forced to provide at most prim and layer file paths (as opposed to direct pxr::UsdPrim objects).

We can't provide the pxr::UsdPrim object directly because USD types can't be part of C++ function signatures that are automatically exposed to scripting languages. Lucikly we can use UsdUtils' stage cache to make sure that C++ and e.g. Python are still referencing the same USD Stage in memory, so that we can e.g. use these functions to convert data within stages created via Python.

   
Name UUsdConversionBlueprintContext
Type class
Header File /Engine/Plugins/Importers/USDImporter/Source/USDExporter/Public/USDConversionBlueprintContext.h
Include Path #include "USDConversionBlueprintContext.h"

Syntax

UCLASS (Meta=(ScriptName="UsdConversionContext"))  
class UUsdConversionBlueprintContext : public UObject

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UUsdConversionBlueprintContext()

   USDConversionBlueprintContext.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEraseFromStageCache bool Whether we will erase our current stage from the stage cache when we Cleanup(). USDConversionBlueprintContext.h  
Stage UE::FUsdStage Stage to use when converting components USDConversionBlueprintContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Cleanup ()

 Discards the currently opened stage. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Export context"

bool ConvertAudioComponent ( const UAudioComponent* Component,
const FString& PrimPath,
float TimeCode,
bool bFilePathOnly
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertCineCameraComponent ( const UCineCameraComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertDirectionalLightComponent ( const UDirectionalLightComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertDrawModeComponent ( const UUsdDrawModeComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertHismComponent ( const UHierarchicalInstancedStaticMeshComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertInstancedFoliageActor ( const AInstancedFoliageActor* Actor,
const FString& PrimPath,
ULevel* InstancesLevel,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertIsmComponent ( const UInstancedStaticMeshComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertLandscapeProxyActorMaterial ( ALandscapeProxy* Actor,
const FString& PrimPath,
const TArray< FPropertyEntry >& PropertiesToBake,
const FIntPoint& DefaultTextureSize,
const FDirectoryPath& TexturesDir,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertLandscapeProxyActorMesh ( const ALandscapeProxy* Actor,
const FString& PrimPath,
int32 LowestLOD,
int32 HighestLOD,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertLightComponent ( const ULightComponentBase* Component,
const FString& PrimPath,
float TimeCode
)

 Note: We use FLT_MAX on these functions because Usd.TimeCode.Default().GetValue() is actually a nan, and nan arguments are automatically sanitized to 0.0f. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertMaterialOverrides ( const UObject* MeshAsset,
const TArray< UMaterialInterface* > MaterialOverrides,
const FString& PrimPath,
int32 LowestLOD,
int32 HighestLOD
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils"

bool ConvertMeshComponent ( const UMeshComponent* Component,
const FString& PrimPath
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertPointLightComponent ( const UPointLightComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertRectLightComponent ( const URectLightComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertSceneComponent ( const USceneComponent* Component,
const FString& PrimPath
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertSkyLightComponent ( const USkyLightComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

bool ConvertSpotLightComponent ( const USpotLightComponent* Component,
const FString& PrimPath,
float TimeCode
)

   USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Component conversion"

FFilePath GetEditTarget()

 Gets the filepath of the current edit target layer of our internal stage USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Export context"

FUsdUnrealAssetInfo GetPrimAssetInfo ( const FString& PrimPath
)

 Retrieves from Prim the assetInfo metadata values that we use as export metadata, when exporting Unreal assets USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils|Metadata"

FUsdCombinedPrimMetadata GetPrimMetadata ( const FString& PrimPath,
const TArray< FString >& BlockedPrefixFilter,
bool bInvertFilter,
bool bCollectFromEntireSubtrees
)

 Extracts metadata from the prim at PrimPath using the provided filters and returns it USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils|Metadata"

FFilePath GetStageRootLayer()

 Gets the file path of the root layer of our current stage USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Export context"

int32 GetUsdStageNumFrames()

 Returns how many frames of animation the stage would generate if imported USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils"

bool RemoveUnrealSurfaceOutput ( const FString& PrimPath,
const FFilePath& LayerToAuthorIn
)

 Clears any opinions for the 'unreal' render context surface output of MaterialPrim within LayerToAuthorIn. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils"

void ReplaceUnrealMaterialsWithBaked ( const FFilePath& LayerToAuthorIn,
const TMap< FString, FString >& BakedMaterials,
bool bIsAssetLayer,
bool bUsePayload,
bool bRemoveUnrealMaterials
)

 Traverses the context's stage and authors material binding attributes for all `unrealMaterials_ that were baked into USD material assets. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils"

void SetEditTarget ( FFilePath EditTargetLayerPath
)

 Sets the current edit target of our internal stage. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Export context"

void SetPrimAssetInfo ( const FString& PrimPath,
const FUsdUnrealAssetInfo& Info
)

 Adds to Prim the assetInfo metadata the values described in Info USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils|Metadata"

void SetPrimMetadata ( const FString& PrimPath,
const FUsdCombinedPrimMetadata& Metadata,
const TArray< FString >& BlockedPrefixFilter,
bool bInvertFilter
)

 Applies Metadata to the prim specified at PrimPath, using the provided filters USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils|Metadata"

void SetPrimMetadataFromUserData ( const FString& PrimPath,
const UUsdAssetUserData* UserData,
const TArray< FString >& BlockedPrefixFilter,
bool bInvertFilter
)

 Applies all the metadata contained in UserData to the prim specified at PrimPath, using the provided filters USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Conversion utils|Metadata"

void SetStageRootLayer ( FFilePath StageRootLayerPath
)

 Opens or creates a USD stage using `StageRootLayerPath_ as root layer, creating the root layer if needed. USDConversionBlueprintContext.h
  • BlueprintCallable
  • Category="Export context"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page