UAtomCueSheet类 参考

#include <AtomCueSheet.h>

类 UAtomCueSheet 继承关系图:

Public 成员函数
	UAtomCueSheet (const FObjectInitializer &ObjectInitializer)
virtual void	BeginDestroy () override
virtual bool	CanUnloadAtomResource () override
virtual FAtomResource *	CreateAtomResource () override
virtual void	DestroyAtomResource () override
virtual void	FinishDestroy () override
int32	GetNumCues () const
virtual int	GetNumSounds () const override
virtual const uint8 *	GetResourceData () override
virtual UAtomSoundBase *	GetSound (int Index) const override
virtual UClass *	GetSoundClass () const override
UAtomSoundCue *	GetSoundCue (int Index) const
UAtomSoundCue *	GetSoundCueByName (const FString &CueName) 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 成员函数 继承自 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 ()

Public 属性
TArray< TObjectPtr< UAtomWaveBank > >	WaveBanks
Public 属性 继承自 UAtomSoundBank
FAtomResourceHandle	AtomResource
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe >	bLoadingBehaviorOverriddenPtr { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }
EAtomSoundWaveLoadingBehavior	CachedSoundWaveLoadingBehavior { EAtomSoundWaveLoadingBehavior::Uninitialized }
EAtomSoundWaveLoadingBehavior	LoadingBehavior
FByteBulkData	RawData
FCriticalSection	RawDataCriticalSection

Private 属性
FOwnedBulkDataPtr *	OwnedBulkDataPtr { nullptr }
const uint8 *	ResourceData { nullptr }
int32	ResourceSize
TArray< TObjectPtr< UAtomSoundCue > >	SoundCues

友元
class	UAtomCueSheetFactory

额外继承的成员函数
Protected 属性 继承自 UAtomSoundBank
TSharedPtr< FThreadSafeBool, ESPMode::ThreadSafe >	bIsStreamingProxyFlag { MakeShared<FThreadSafeBool, ESPMode::ThreadSafe>() }

详细描述

UAtomCueSheet Class

构造及析构函数说明

UAtomCueSheet()

UAtomCueSheet::UAtomCueSheet

(

const FObjectInitializer &

ObjectInitializer

)

成员函数说明

BeginDestroy()

void UAtomCueSheet::BeginDestroy ( )

overridevirtual

CanUnloadAtomResource()

bool UAtomCueSheet::CanUnloadAtomResource ( )

overridevirtual

重载 IAtomSoundResource .

CreateAtomResource()

FAtomResource * UAtomCueSheet::CreateAtomResource ( )

overridevirtual

重载 IAtomSoundResource .

DestroyAtomResource()

void UAtomCueSheet::DestroyAtomResource ( )

overridevirtual

重载 IAtomSoundResource .

FinishDestroy()

void UAtomCueSheet::FinishDestroy ( )

overridevirtual

GetNumCues()

int32 UAtomCueSheet::GetNumCues

(

)

const

Gets the number of wave in this bank.

返回

The number of waves.

GetNumSounds()

int UAtomCueSheet::GetNumSounds ( ) const

overridevirtual

重载 UAtomSoundBank .

GetResourceData()

const uint8 * UAtomCueSheet::GetResourceData ( )

overridevirtual

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

重载 IAtomSoundResource .

GetSound()

UAtomSoundBase * UAtomCueSheet::GetSound ( int Index ) const

overridevirtual

重载 UAtomSoundBank .

GetSoundClass()

UClass * UAtomCueSheet::GetSoundClass ( ) const

overridevirtual

重载 UAtomSoundBank .

GetSoundCue()

UAtomSoundCue * UAtomCueSheet::GetSoundCue ( int Index ) const

inline

Gets the cue object from this bank at choosen index.

返回

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

GetSoundCueByName()

UAtomSoundCue * UAtomCueSheet::GetSoundCueByName

(

const FString &

CueName

)

const

Retreive the cue object from this bank by its name.

返回

The UAtomSoundCue with the chosen name in the bank or nullptr if the cue was not found.

InitAtomResource()

bool UAtomCueSheet::InitAtomResource ( )

overridevirtual

Copy/Steal the acb data from the bulk data

重载 IAtomSoundResource .

IsLoaded()

bool UAtomCueSheet::IsLoaded

(

)

const

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

返回

true if the bank is loaded.

IsReadyForFinishDestroy()

bool UAtomCueSheet::IsReadyForFinishDestroy ( )

overridevirtual

PostInitProperties()

void UAtomCueSheet::PostInitProperties ( )

overridevirtual

PostLoad()

void UAtomCueSheet::PostLoad ( )

overridevirtual

RemoveAtomResource()

void UAtomCueSheet::RemoveAtomResource ( )

overridevirtual

Remove the data associated with the passed acb

重载 IAtomSoundResource .

Serialize()

void UAtomCueSheet::Serialize ( FArchive & Ar )

overridevirtual

重载 UAtomSoundBank .

Validate()

bool UAtomCueSheet::Validate ( ) const

virtual

Validates the Atom cue sheet settings.

返回

true if validation passed, false otherwise.

友元及相关符号说明

UAtomCueSheetFactory

friend class UAtomCueSheetFactory

friend

类成员变量说明

OwnedBulkDataPtr

FOwnedBulkDataPtr* UAtomCueSheet::OwnedBulkDataPtr { nullptr }

private

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

ResourceData

const uint8* UAtomCueSheet::ResourceData { nullptr }

private

ResourceSize

int32 UAtomCueSheet::ResourceSize

private

Size of resource copied from the bulk data.

SoundCues

TArray<TObjectPtr<UAtomSoundCue> > UAtomCueSheet::SoundCues

private

WaveBanks

TArray<TObjectPtr<UAtomWaveBank> > UAtomCueSheet::WaveBanks

AtomWaveBank used by this AtomCueSheet. (Property is hidden in editor if ACB does not request any AtomWaveBanks.)

---

该类的文档由以下文件生成:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/AtomCueSheet.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/AtomCueSheet.cpp