Open 3D Engine AtomLyIntegration Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AZ::AtomBridge::AssetCollectionAsyncLoaderTestInterface Class Referenceabstract

#include <AssetCollectionAsyncLoaderTestComponent.h>

Inherits ComponentBus.

Public Member Functions

 AZ_RTTI (AssetCollectionAsyncLoaderTestInterface, "{2C000A68-3B9A-4462-B8CF-E2995FA2C208}")
 
virtual ~AssetCollectionAsyncLoaderTestInterface ()
 
virtual bool StartLoadingAssetsFromJsonFile (const AZStd::string &pathToAssetListJson)=0
 
virtual bool StartLoadingAssetsFromAssetList (const AZStd::vector< AZStd::string > &assetList)=0
 
virtual void CancelLoadingAssets ()=0
 Cancels any pending job to that has been queued by this component.
 
virtual AZStd::vector< AZStd::string > GetPendingAssetsList () const =0
 Returns a list of the assets that have not been loaded yet from the Asset Processor Cache.
 
virtual uint32_t GetCountOfPendingAssets () const =0
 Shortcut to GetPendingAssetsList().size()
 
virtual bool ValidateAssetWasLoaded (const AZStd::string &assetPath) const =0
 Returns true if the asset was loaded successfully.
 

Static Public Attributes

static const EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Single
 

Detailed Description

Interface for AZ::AtomBridge::AssetCollectionAsyncLoaderTestBus, which is an EBus that receives requests to test AssetCollectionAsyncLoader API

Constructor & Destructor Documentation

◆ ~AssetCollectionAsyncLoaderTestInterface()

virtual AZ::AtomBridge::AssetCollectionAsyncLoaderTestInterface::~AssetCollectionAsyncLoaderTestInterface ( )
inlinevirtual

Destroys the instance of the class.

Member Function Documentation

◆ StartLoadingAssetsFromAssetList()

virtual bool AZ::AtomBridge::AssetCollectionAsyncLoaderTestInterface::StartLoadingAssetsFromAssetList ( const AZStd::vector< AZStd::string > &  assetList)
pure virtual

@assetList Similar as above but the list of assets is given directly. Returns true if the asset loading job starts successfully.

◆ StartLoadingAssetsFromJsonFile()

virtual bool AZ::AtomBridge::AssetCollectionAsyncLoaderTestInterface::StartLoadingAssetsFromJsonFile ( const AZStd::string &  pathToAssetListJson)
pure virtual

@pathToAssetListJson Path to a json file with a plain list of file paths. Each path is the path of an asset product. The AssetType will be deduced from the file extension. Returns true if the asset loading job starts successfully.

The documentation for this class was generated from the following file: