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.

Unreal Engine C++ API Reference > Plugins > USDExporter

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Meta&61;&40;ScriptName&61;"UsdConversionContext"&41;&41;  
class UUsdConversionBlueprintContext : public UObject

Remarks

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.

Destructors

No destructors are accessible with public or protected access.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

Cleanup ()

 Discards the currently opened stage.
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category bool

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

  
Public function UFunction BlueprintCallable, Category FFilePath Gets the filepath of the current edit target layer of our internal stage
Public function UFunction BlueprintCallable, Category FUsdUnrealAssetInfo

GetPrimAssetInfo ( const FString& PrimPath
)

 Retrieves from Prim the assetInfo metadata values that we use as export metadata, when exporting Unreal assets
Public function UFunction BlueprintCallable, Category FFilePath Gets the file path of the root layer of our current stage
Public function UFunction BlueprintCallable, Category int32 Returns how many frames of animation the stage would generate if imported
Public function UFunction BlueprintCallable, Category bool

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

 Clears any opinions for the 'unreal' render context surface output of MaterialPrim within LayerToAuthorIn.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category void

SetEditTarget ( FFilePath EditTargetLayerPath
)

 Sets the current edit target of our internal stage.
Public function UFunction BlueprintCallable, Category void

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

 Adds to Prim the assetInfo metadata the values described in Info
Public function UFunction BlueprintCallable, Category void

SetStageRootLayer ( FFilePath StageRootLayerPath
)

 Opens or creates a USD stage using `StageRootLayerPath_ as root layer, creating the root layer if needed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page