CriWare Unreal Engine
Plug-ins for CriWare solutions.
Loading...
Searching...
No Matches
UAtomWaveBank Class Reference

#include <AtomWaveBank.h>

Inheritance diagram for UAtomWaveBank:

Public Member Functions

 UAtomWaveBank (const FObjectInitializer &ObjectInitializer)
virtual void BeginDestroy () override
virtual bool CanUnloadAtomResource () override
virtual FAtomResource * CreateAtomResource () override
virtual void DestroyAtomResource () override
virtual void FinishDestroy () override
virtual int GetNumSounds () const override
int32 GetNumWaves () const
virtual const uint8 * GetResourceData () override
virtual UAtomSoundBase * GetSound (int Index) const override
virtual UClass * GetSoundClass () const override
UAtomSoundWave * GetSoundWave (int Index) const
virtual bool InitAtomResource () override
bool IsLoaded () const
virtual bool IsReadyForFinishDestroy () override
virtual void PostInitProperties () override
virtual void PostLoad () override
virtual void RemoveAtomResource () override
virtual void Serialize (FArchive &Ar) override
virtual bool Validate () const
Public Member Functions inherited from UAtomSoundBank
 UAtomSoundBank (const FObjectInitializer &ObjectInitializer)
void CacheInheritedLoadingBehavior () const
virtual void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const override
EAtomSoundWaveLoadingBehavior GetLoadingBehavior () const
FByteBulkData * GetRawData ()
virtual bool IsRetainingResource () const
bool IsStreaming (const FCriWareCookOverridesSettings &Overrides) const
bool IsStreaming (const TCHAR *PlatformName=nullptr) const
virtual void ReleaseResource ()
virtual void RetainResource ()

Private Attributes

FOwnedBulkDataPtr * OwnedBulkDataPtr { nullptr }
const uint8 * ResourceData { nullptr }
int32 ResourceSize
TArray< TObjectPtr< UAtomSoundWave > > SoundWaves

Friends

class UAtomWaveBankFactory

Additional Inherited Members

Public Attributes inherited from UAtomSoundBank
FAtomResourceHandle AtomResource
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe > bLoadingBehaviorOverriddenPtr { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }
EAtomSoundWaveLoadingBehavior CachedSoundWaveLoadingBehavior { EAtomSoundWaveLoadingBehavior::Uninitialized }
EAtomSoundWaveLoadingBehavior LoadingBehavior
FByteBulkData RawData
FCriticalSection RawDataCriticalSection
Protected Attributes inherited from UAtomSoundBank
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe > bIsStreamingProxyFlag { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }

Detailed Description

UAtomWaveBank Class

Constructor & Destructor Documentation

◆ UAtomWaveBank()

UAtomWaveBank::UAtomWaveBank ( const FObjectInitializer & ObjectInitializer)

Member Function Documentation

◆ BeginDestroy()

void UAtomWaveBank::BeginDestroy ( )
overridevirtual

◆ CanUnloadAtomResource()

bool UAtomWaveBank::CanUnloadAtomResource ( )
overridevirtual

Reimplemented from IAtomSoundResource.

◆ CreateAtomResource()

FAtomResource * UAtomWaveBank::CreateAtomResource ( )
overridevirtual

Reimplemented from IAtomSoundResource.

◆ DestroyAtomResource()

void UAtomWaveBank::DestroyAtomResource ( )
overridevirtual

Reimplemented from IAtomSoundResource.

◆ FinishDestroy()

void UAtomWaveBank::FinishDestroy ( )
overridevirtual

◆ GetNumSounds()

int UAtomWaveBank::GetNumSounds ( ) const
overridevirtual

Reimplemented from UAtomSoundBank.

◆ GetNumWaves()

int32 UAtomWaveBank::GetNumWaves ( ) const

Gets the number of wave in this bank.

Returns
The number of waves.

◆ GetResourceData()

const uint8 * UAtomWaveBank::GetResourceData ( )
overridevirtual

Get the pointer on acb data if available, otherwise nullptr.

Reimplemented from IAtomSoundResource.

◆ GetSound()

UAtomSoundBase * UAtomWaveBank::GetSound ( int Index) const
overridevirtual

Reimplemented from UAtomSoundBank.

◆ GetSoundClass()

UClass * UAtomWaveBank::GetSoundClass ( ) const
overridevirtual

Reimplemented from UAtomSoundBank.

◆ GetSoundWave()

UAtomSoundWave * UAtomWaveBank::GetSoundWave ( int Index) const
inline

Gets the wave object from this bank at choosen index.

Returns
The UAtomSoundWave at the index in the bank or nullptr if an invalid index was provided.

◆ InitAtomResource()

bool UAtomWaveBank::InitAtomResource ( )
overridevirtual

Copy/Steal the acb data from the bulk data

Reimplemented from IAtomSoundResource.

◆ IsLoaded()

bool UAtomWaveBank::IsLoaded ( ) const

Returns load status of the the bank in Atom library and if ready to be accessed.

Returns
true if the bank is loaded.
See also
SetFilePath

◆ IsReadyForFinishDestroy()

bool UAtomWaveBank::IsReadyForFinishDestroy ( )
overridevirtual

◆ PostInitProperties()

void UAtomWaveBank::PostInitProperties ( )
overridevirtual

◆ PostLoad()

void UAtomWaveBank::PostLoad ( )
overridevirtual

◆ RemoveAtomResource()

void UAtomWaveBank::RemoveAtomResource ( )
overridevirtual

Remove the data associated with the passed acb

Reimplemented from IAtomSoundResource.

◆ Serialize()

void UAtomWaveBank::Serialize ( FArchive & Ar)
overridevirtual

Reimplemented from UAtomSoundBank.

◆ Validate()

bool UAtomWaveBank::Validate ( ) const
virtual

Validates the Atom wave bank settings.

Returns
true if validation passed, false otherwise.

◆ UAtomWaveBankFactory

friend class UAtomWaveBankFactory
friend

Member Data Documentation

◆ OwnedBulkDataPtr

FOwnedBulkDataPtr* UAtomWaveBank::OwnedBulkDataPtr { nullptr }
private

Memory containing the data copied or mapped from the raw bulk data.

◆ ResourceData

const uint8* UAtomWaveBank::ResourceData { nullptr }
private

◆ ResourceSize

int32 UAtomWaveBank::ResourceSize
private

Size of resource copied from the bulk data.

◆ SoundWaves

TArray<TObjectPtr<UAtomSoundWave> > UAtomWaveBank::SoundWaves
private
The documentation for this class was generated from the following files:
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomWaveBank.h
  • C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomWaveBank.cpp