1. Epic GamesDeveloper
  3. USDUtilities

USDUtilities

Unreal Engine C++ API Reference > Plugins

Classes

  Type Name Description
Public struct FCaseSensitiveStringMapFuncs Case sensitive hashing function for TMap  
Public struct FConvertedVtValue Corresponds to a value held by a pxr::VtValue converted into UE types.  
Public struct FDisplayColorMaterial Describes the type of vertex color/DisplayColor material that we would need in order to render a prim's displayColor data as intended  
Public class FScopedUsdMessageLog Starts sending USD messages to the message log and will display the message log on destruction if any messages were logged.  
Public struct FUsdBlendShape    
Public struct FUsdBlendShapeInbetween    
Public class FUsdLogManager    
Public class FUsdMessageLog    
Public struct FUsdPrimMaterialAssignmentInfo Complete description of material assignment data of a pxr::UsdPrim  
Public struct FUsdPrimMaterialSlot Description of a material slot we need to add to a UStaticMesh or USkeletalMesh to have it represent a material binding in a prim.  
Public class IUsdUtilitiesModule    

Typedefs

Name Description
FBlendShapeMap Maps from a full blend shape path (e.g. '/Scene/Mesh/BlendShapeName') to the parsed FUsdBlendShape struct.
FConvertedVtValueComponent WARNING: Do not change the order of the types in this TVariant declaration, or it will break backwards compatibility with data that was serialized before the change, due to how `operator<<( FArchive& Ar, FConvertedVtValueComponent& Component )_ is implemented
FConvertedVtValueEntry Represents a single non-array value held by a pxr::VtValue object, like a 'float', a 'TfToken' or a 'GfMatrix3d'

Enums

  Type Name Description
Public enum UsdUtils::EPrimAssignmentType Describes what type of material assignment a FUsdPrimMaterialSlot represents  
Public enum UsdUtils::EUsdBasicDataTypes Source: https://graphics.pixar.com/usd/docs/api/_usd__page__datatypes.html  

Functions

  Type Name Description
Public function void

UsdUtils::AddPayload ( UE::FUsdPrim& Prim,
const TCHAR* AbsoluteFilePath,
const UE::FSdfPath& TargetPrimPath,
double TimeCodeOffset,
double TimeCodeScale
)

 Adds a payload on Prim pointing at the default prim of the layer at AbsoluteFilePath
Public function void

UsdUtils::AddReference ( UE::FUsdPrim& Prim,
const TCHAR* AbsoluteFilePath,
const UE::FSdfPath& TargetPrimPath,
double TimeCodeOffset,
double TimeCodeScale
)

 Adds a reference on Prim to the layer at AbsoluteFilePath
Public function bool Returns true if we have prims that we can paste within our clipboard stage
Public function void Clears all prims from our clipboard stage
Public function void

UsdUtils::CollectSchemaAnalytics ( const UE::FUsdStage& Stage,
const FString& EventName
)

 Collects how many times each schema shows up on the provided stage and send it as an analytics event
Public function bool Copies flattened versions of the input prims onto the clipboard stage.
Public function bool

UsdUtils::CutPrims ( const TArray< UE::FUsdPrim >& Prims
)

 Copies flattened versions of the input prims onto the clipboard stage and removes all the prim specs for Prims from their stages.
Public function TArray< UE::FSdfPath >

UsdUtils::DuplicatePrims ( const TArray< UE::FUsdPrim >& Prims,
EUsdDuplicateType DuplicateType,
const UE::FSdfLayer& TargetLayer
)

 Duplicates all provided Prims one-by-one, performing the requested DuplicateType.
Public function T *

UsdUtils::FindOrCreateObject ( UObject* InParent,
const FString& InName,
EObjectFlags Flags
)

  
Public function TArray< UE::FUsdPrim >

UsdUtils::GetAllPrimsOfType ( const UE::FUsdPrim& StartPrim,
const TCHAR* SchemaName
)

  
Public function TArray< UE::FUsdPrim >

UsdUtils::GetAllPrimsOfType ( const UE::FUsdPrim& StartPrim,
const TCHAR* SchemaName,
TFunction< bool(const UE::FUsdPrim&) > PruneChildren,
const TArray< const TCHAR* >& ExcludeSchemaNames
)

  
Public function UUsdAssetImportData * Utilities to allow getting and setting our AssetImportData to an asset from a base UObject*.
Public function double Returns the time code for non-timesampled values. Usually a quiet NaN.
Public function double Returns the earliest possible timecode.
Public function FUsdUnrealAssetInfo Retrieves from Prim the assetInfo metadata values that we use as export metadata, when exporting Unreal assets
Public function UE::FSdfPath Returns a path exactly like Prim.GetPrimPath(), except that if the prim is within variant sets, it will return the full path with variant selections in it (i.e. the spec path), like "/Root/Child{Varset=Var}Inner" instead of just "/Root/Child/Inner".
Public function bool

UsdUtils::GetReferenceFilePath ( const UE::FUsdPrim& Prim,
const FString& FileExtension,
FString& OutReferenceFilePath
)

 Gets the strongest direct reference on Prim with the given FileExtension.
Public function FString

UsdUtils::GetUniqueName ( FString Name,
const TSet< FString >& UsedNames
)

 Appends numbered suffixes to Name until the result is not contained in UsedNames, and returns it.
Public function TArray< UE::FUsdPrim >

UsdUtils::GetVisibleChildren ( const UE::FUsdPrim& Prim,
EUsdPurpose AllowedPurposes
)

 Returns the prims in the subtree of Prim (potentially including Prim itself) that are visible due to the visibility attribute and prim purpose
Public function bool

UsdUtils::HasInheritedVisibility ( const UE::FUsdPrim& Prim,
double TimeCode
)

 Returns whether Prim has visibility set to 'inherited'
Public function bool

UsdUtils::HasInvisibleParent ( const UE::FUsdPrim& Prim,
const UE::FUsdPrim& RootPrim,
double TimeCode
)

 Travels up from Prim and returns true if we hit any invisible prim before we hit the stage pseudoroot.
Public function bool

UsdUtils::IsAttributeMuted ( const UE::FUsdAttribute& Attribute,
const UE::FUsdStage& Stage
)

 Returns whether this attribute has the "Muted" CustomData on the stage's UE state sublayer, meaning it shouldn't be animated when loaded into UE
Public function bool

UsdUtils::IsVisible ( const UE::FUsdPrim& Prim,
double TimeCode
)

 Returns if the ComputedVisibility for Prim says it should be visible
Public function void

UsdUtils::MakeInvisible ( UE::FUsdPrim& Prim,
double TimeCode
)

  
Public function void

UsdUtils::MakeVisible ( UE::FUsdPrim& Prim,
double TimeCode
)

 Will call UsdGeomImageable::MakeVisible/MakeInvisible if Prim is a UsdGeomImageable
Public function bool Adds a "Muted" CustomData entry to the attribute at the stage's UE state sublayer, which will prevent it from being animated when loaded into UE
Public function TArray< UE::FSdfPath >

UsdUtils::PastePrims ( const UE::FUsdPrim& ParentPrim
)

 Pastes the prims from the clipboard stage as children of ParentPrim.
Public function void Removes all the prim specs for Prim on the given Layer, if the layer belongs to the stage's local layer stack.
Public function bool Removes any numbered suffix, followed by any number of underscores (e.g. Asset_2, Asset__232_31 or Asset94 all become 'Asset'), making sure the string is kept at least one character long.
Public function bool

UsdUtils::RenamePrim ( UE::FUsdPrim& Prim,
const TCHAR* NewPrimName
)

 Renames a single prim to a new name WARNING: This will lead to issues if called from within a pxr::SdfChangeBlock.
Public function void

UsdUtils::ResolveWeightsForBlendShape ( const FUsdBlendShape& InBlendShape,
float InWeight,
float& OutPrimaryWeight,
TArray< float >& OutInbetweenWeights
)

 We decompose inbetween blend shapes on import into separate morph targets, alongside the primary blend shape, which also becomes a morph target.
Public function FString

UsdUtils::SanitizeUsdIdentifier ( const TCHAR* InIdentifier
)

 Returns a modified version of InIdentifier that can be used as a USD prim or property name.
Public function void  
Public function void Adds to Prim the assetInfo metadata the values described in Info
Public function bool Removes the "Muted" CustomData entry from the attribute at the stage's UE state sublayer, letting it be animated when loaded into UE

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page