1. Epic GamesDeveloper
  3. UUsdAssetCache2

UUsdAssetCache2

Owns the assets generated and reused by USD Stages, allowing thread-safe retrieval/storage.

API > API/Plugins > API/Plugins/USDClasses

Inheritance Hierarchy

References

   
Module USDClasses
Header /Engine/Plugins/Importers/USDImporter/Source/USDClasses/Public/USDAssetCache2.h
Include #include "USDAssetCache2.h"

Syntax

UCLASS&40;BlueprintType, Blueprintable,  
       Meta&61;&40;DisplayName&61;"USD Asset Cache", ScriptName&61;"UsdAssetCache"&41;&41;  
class UUsdAssetCache2 : public UObject

Remarks

Owns the assets generated and reused by USD Stages, allowing thread-safe retrieval/storage.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite double PersistentAssetStorageSizeMB This limit specifies how much size is allocated to storing all persistent assets (i.e. assets that will be saved to disk, even if unused by any stage).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite double UnreferencedAssetStorageSizeMB The asset cache will always retain all currently used assets.

Constructors

  Type Name Description
Public function    

Functions

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

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

 Adds a new UObject referencer to a particular asset, returning true if the operation succeeded.
Public function UFunction BlueprintCallable, Category, Meta void

CacheAsset ( const FString& Hash,
UObject* Asset,
const UObject* Referencer
)

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

CanRemoveAsset ( const FString& Hash
)

 Returns true if the asset with the given hash can be removed from the cache.
Public function Const TSet< UObject * > Returns assets that aren't marked as stale
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FString > Returns all asset hashes tracked by the asset cache, for all storage types.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FString > Returns all asset paths tracked by the asset cache, for all storage types.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< UObject * > Returns all assets that are currently loaded in the asset cache.
Public function UFunction BlueprintCallable, Category, Meta UObject *

GetCachedAsset ( const FString& Hash
)

 Returns an asset associated with a particular `Hash_.
Public function Const UFunction BlueprintCallable, Category, Meta FString

GetHashForAsset ( const UObject* Asset
)

 Returns the hash associated with an asset, in case we own it.
Public function Const UFunction BlueprintCallable, Category, Meta int32 Returns how many assets are tracked by the asset cache in total (summing up persistent, referenced and unreferenced storage)
Public function Const UFunction BlueprintCallable, Category, Meta bool

IsAssetOwnedByCache ( const FString& AssetPath
)

 Returns true in case the asset at `AssetPath_ is tracked by the cache in any way (persistent asset, unreferenced or referenced).
Public function void Every time an asset is retrieved/inserted we add it to ActiveAssets.
Public function UFunction BlueprintCallable, Category, Meta void Updates which assets belong to each storage type.
Public function UFunction BlueprintCallable, Category, Meta bool

RemoveAllAssetReferences ( const UObject* Referencer
)

 Removes the particular referencer to all assets tracked by the cache, if it was a referencer to any of them.
Public function UFunction BlueprintCallable, Category, Meta UObject *

RemoveAsset ( const FString& Hash
)

 If an asset is associated with `Hash_, it will be returned and the asset cache will stop tracking this asset entirely.
Public function UFunction BlueprintCallable, Category, Meta bool

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

 Removes an UObject referencer from a particular asset, returning true if the operation succeeded.
Public function UFunction BlueprintCallable, Category, Meta void

Reset ()

 Discards all tracked assets across all storage types
Public function UFunction BlueprintCallable, Category, Meta bool

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

 Marks the provided asset as being used at this point, optionally adding a specific referencer.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Begin UObject interfacte.
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.

Enums

  Type Name Description
Private enum ECacheStorageType Describes the different "types of storage" we allow on the asset cache.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page