1. Epic GamesDeveloper
  3. UUsdAssetCache3

UUsdAssetCache3

This class is an asset that can be created via the Content Browser and assigned to AUsdStageActors.

API > API/Plugins > API/Plugins/USDClasses

Inheritance Hierarchy

References

   
Module USDClasses
Header /Engine/Plugins/Runtime/USDCore/Source/USDClasses/Public/USDAssetCache3.h
Include #include "USDAssetCache3.h"

Syntax

UCLASS (BlueprintType, Blueprintable,  
       Meta=(DisplayName="USD Asset Cache", ScriptName="UsdAssetCache"))  
class UUsdAssetCache3 : public UObject

Remarks

This class is an asset that can be created via the Content Browser and assigned to AUsdStageActors.

Its main purpose is to track generated assets based on the hash of the source prim data: Whenever the AUsdStageActor needs to generate e.g. a MaterialInstance, it will first hash the Material prim, and check whether its UUsdAssetCache3 already has an asset of that class for the resulting hash.

The cache can then be shared by multiple AUsdStageActors to prevent recreating UObjects from identical, already translated prim data.

A "Default Asset Cache" can be set on the project settings, and will be automatically used for any AUsdStageActor that hasn't had an asset cache manually set beforehand.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FDirectoryPath AssetDirectory Content directory where the asset cache will place newly created assets.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCleanUpUnreferencedAssets If this is true, every time a UsdStageActor using this asset cache closes a stage or swaps asset caches it will attempt to call DeleteUnreferencedAssets, potentially dropping any unreferenced asset, due to this operation or previous ones.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bOnlyHandleAssetsWithinAssetDirectory When true, it means the asset cache will only ever return assets that are currently inside of the AssetDirectory folder.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TMap< FString, FSoftObjectPath > HashToAssetPaths This is the main internal property that maps hashes to asset paths.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta bool

AddAssetReferencer ( const UObject* Asset,
const UObject* Referencer
)

 Adds a new UObject referencer to a particular asset, returning true if the operation succeeded.
Protected function void

AddReferenceInternal ( const FString& Hash,
const UObject* Referencer
)

  
Public function UFunction BlueprintCallable, Category, Meta void

CacheAsset ( const FString& Hash,
const FSoftObjectPath& AssetPath,
const UObject* Referencer
)

 Adds an existing asset to the cache attached to a particular hash, and optionally registering a referencer
Public function UFunction BlueprintCallable, Category, Meta void

DeleteUnreferencedAssets ( const bool bShowConfirmation
)

 Deletes all assets that:
Public function UFunction BlueprintCallable, Category, Meta void This is the same as calling DeleteUnreferencedAssets and providing true for bShowConfirmation.
Protected function void

ForceValidAssetDirectoryInternal ( bool bEmitWarning
)

  
Public function Const TSet< FSoftObjectPath >  
Public function Const UFunction BlueprintCallable, Category, Meta TMap< FString, FSoftObjectPath > Returns a copy of the internal mapping between hashes and asset paths
Public function T *

GetCachedAsset ( const FString& Hash
)

 Templated version of GetCachedAsset for convenience
Public function Const UFunction BlueprintCallable, Category, Meta UObject *

GetCachedAsset ( const FString& Hash
)

 Returns the asset associated with a particular Hash, if any.
Public function Const UFunction BlueprintCallable, Category, Meta FSoftObjectPath

GetCachedAssetPath ( const FString& Hash
)

 Returns the internal FSoftObjectPath associated with Hash, without trying to load the asset.
Public function Const UFunction BlueprintCallable, Category, Meta FString

GetHashForAsset ( const FSoftObjectPath& AssetPath
)

 Returns the hash associated with a particular asset, or the empty string if there isn't any.
Public function Const UFunction BlueprintCallable, Category, Meta int32 Returns the total number of cached asset paths, whether these resolve to assets or not
Public function UFunction BlueprintCallable, Category, Meta UObject *

GetOrCreateCachedAsset ( const FString& Hash,
UClass* Class,
const FString& DesiredName,
int32 DesiredFlags,
bool& bOutCreatedAsset,
const UObject* Referencer
)

 Returns the cached UObject of the provided Class for the provided Hash if one exists.
Public function T *

GetOrCreateCachedAsset ( const FString& Hash,
FString DesiredName,
EObjectFlags DesiredFlags,
bool* bOutCreatedAsset,
const UObject* Referencer
)

 Templated version of GetOrCreateCachedAsset for convenience
Public function T *

GetOrCreateCustomCachedAsset ( const FString& Hash,
FString DesiredName,
EObjectFlags DesiredFlags,
TFunctionRef< UObject*(UPackage*PackageOuter, FName SanitizedName, EObjectFlags FlagsToUse...,
bool* bOutCreatedAsset,
const UObject* Referencer
)

 Templated version of GetOrCreateCachedAsset for convenience
Public function UObject *

GetOrCreateCustomCachedAsset ( const FString& Hash,
UClass* Class,
const FString& DesiredName,
EObjectFlags DesiredFlags,
TFunctionRef< UObject*(UPackage*PackageOuter, FName SanitizedName, EObjectFlags FlagsToUse...,
bool* bOutCreatedAsset,
const UObject* Referencer
)

 For most asset types GetOrCreateCachedAsset should suffice: It will internally call NewObject().
Public function Const UFunction BlueprintCallable, Category, Meta bool

IsAssetDeletable ( const UObject* Asset
)

 Returns whether a particular asset is currently marked as deletable or not
Public function Const UFunction BlueprintCallable, Category, Meta bool

IsAssetTrackedByCache ( const FSoftObjectPath& AssetPath
)

 Returns true if this asset is currently tracked by the asset cache's main hash to asset maps
Protected function bool  
Public function Const UFunction BlueprintCallable, Category, Meta TMap< FString, UObject * > The same as GetAllTrackedAssets, except that it will automatically try loading all the asset paths before returning, which should be convenient for Python or Blueprint callers.
Public function void  
Public function void

OnRegistryAssetRenamed ( const FAssetData& NewAssetData,
const FString& OldName
)

  
Public function UFunction BlueprintCallable, Category, Meta bool Removes all UObject referencer from all tracked assets, returning true if anything was removed.
Protected function bool  
Public function UFunction BlueprintCallable, Category, Meta bool

RemoveAllReferencerAssets ( const UObject* Referencer
)

 Removes a particular UObject referencer from all tracked assets, returning true if anything was removed.
Public function UFunction BlueprintCallable, Category, Meta bool Removes all UObject referencers from a particular asset, returning true if anything was removed.
Public function UFunction BlueprintCallable, Category, Meta bool

RemoveAssetReferencer ( const UObject* Asset,
const UObject* Referencer
)

 Removes an UObject referencer from a particular asset, returning true if anything was removed.
Public function void  
Public function UFunction BlueprintCallable, Category, Meta void Checks the current AssetDirectory for any new assets that were generated from USD, and automatically caches them if possible.
Public function UFunction BlueprintCallable, Category, Meta void

SetAssetDeletable ( const UObject* Asset,
bool bIsDeletable
)

 Sets a particular asset as deletable or not.
Public function const UObject *

SetCurrentScopedReferencer ( const UObject* NewReferencer
)

  
Public function UFunction BlueprintCallable, Category, Meta FSoftObjectPath

StopTrackingAsset ( const FString& Hash
)

 Removes all info about the asset associated with Hash from this cache, if there is any.
Protected function FSoftObjectPath  
Public function void

TouchAsset ( const FString& Hash,
const UObject* Referencer
)

  
Protected function void

TouchAssetInternal ( const FSoftObjectPath& AssetPath,
const UObject* Referencer
)

  
Public function void

TouchAssetPath ( const FSoftObjectPath& AssetPath,
const UObject* Referencer
)

  
Protected function void  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct FUsdScopedReferencer The UUsdAssetCache3 can track all the UObjects that are referencing assets, so that it knows when to discard an unreferenced asset.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page