Atom::IQuartzQuantizedCommand Class Reference

#include <AtomQuartzQuantizationUtilities.h>

Inheritance diagram for Atom::IQuartzQuantizedCommand:

Public Member Functions
CRIWARECORE_API	IQuartzQuantizedCommand ()
virtual CRIWARECORE_API	~IQuartzQuantizedCommand ()
CRIWARECORE_API void	AboutToStart ()
CRIWARECORE_API void	AddSubscriber (Audio::FQuartzGameThreadSubscriber InSubscriber)
CRIWARECORE_API void	Cancel ()
CRIWARECORE_API void	FailedToQueue (FQuartzQuantizedRequestData &InGameThreadData)
virtual FName	GetCommandName () const =0
virtual EQuartzCommandType	GetCommandType () const =0
virtual CRIWARECORE_API TSharedPtr< IQuartzQuantizedCommand >	GetDeepCopyOfDerivedObject () const
virtual bool	IsClockAltering ()
CRIWARECORE_API void	OnClockPaused ()
CRIWARECORE_API void	OnClockStarted ()
CRIWARECORE_API void	OnFinalCallback (int32 InNumFramesLeft)
CRIWARECORE_API void	OnQueued (const FQuartzQuantizedCommandInitInfo &InCommandInitInfo)
CRIWARECORE_API void	OnScheduled (const Audio::FQuartzClockTickRate &InTickRate)
virtual int32	OverrideFramesUntilExec (int32 NumFramesUntilExec)
virtual bool	RequiresAtomRuntime () const
virtual bool	ShouldDeadlineIgnoresBpmChanges ()
CRIWARECORE_API void	Update (int32 NumFramesUntilDeadline)

Private Member Functions
virtual void	AboutToStartCustom ()
virtual void	CancelCustom ()
virtual void	FailedToQueueCustom ()
virtual void	OnClockPausedCustom ()
virtual void	OnClockStartedCustom ()
virtual void	OnFinalCallbackCustom (int32 InNumFramesLeft)
virtual void	OnQueuedCustom (const FQuartzQuantizedCommandInitInfo &InCommandInitInfo)

Private Attributes
int32	GameThreadDelegateID { -1 }
TArray< Audio::FQuartzGameThreadSubscriber >	GameThreadSubscribers

Constructor & Destructor Documentation

IQuartzQuantizedCommand()

Atom::IQuartzQuantizedCommand::IQuartzQuantizedCommand ( )

default

~IQuartzQuantizedCommand()

Atom::IQuartzQuantizedCommand::~IQuartzQuantizedCommand ( )

virtualdefault

Member Function Documentation

AboutToStart()

void Atom::IQuartzQuantizedCommand::AboutToStart

(

)

AboutToStartCustom()

virtual void Atom::IQuartzQuantizedCommand::AboutToStartCustom ( )

inlineprivatevirtual

AddSubscriber()

void Atom::IQuartzQuantizedCommand::AddSubscriber

(

Audio::FQuartzGameThreadSubscriber

InSubscriber

)

Cancel()

void Atom::IQuartzQuantizedCommand::Cancel

(

)

CancelCustom()

virtual void Atom::IQuartzQuantizedCommand::CancelCustom ( )

inlineprivatevirtual

Reimplemented in Atom::FQuantizedPlayCommand.

FailedToQueue()

void Atom::IQuartzQuantizedCommand::FailedToQueue

(

FQuartzQuantizedRequestData &

InGameThreadData

)

FailedToQueueCustom()

virtual void Atom::IQuartzQuantizedCommand::FailedToQueueCustom ( )

inlineprivatevirtual

GetCommandName()

virtual FName Atom::IQuartzQuantizedCommand::GetCommandName ( ) const

pure virtual

Implemented in Atom::FQuantizedNotify, Atom::FQuantizedOtherClockStart, Atom::FQuantizedPlayCommand, Atom::FQuantizedQueueCommand, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

GetCommandType()

virtual EQuartzCommandType Atom::IQuartzQuantizedCommand::GetCommandType ( ) const

pure virtual

Implemented in Atom::FQuantizedNotify, Atom::FQuantizedOtherClockStart, Atom::FQuantizedPlayCommand, Atom::FQuantizedQueueCommand, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

GetDeepCopyOfDerivedObject()

TSharedPtr< IQuartzQuantizedCommand > Atom::IQuartzQuantizedCommand::GetDeepCopyOfDerivedObject ( ) const

virtual

Reimplemented in Atom::FQuantizedNotify, Atom::FQuantizedOtherClockStart, Atom::FQuantizedPlayCommand, Atom::FQuantizedQueueCommand, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

IsClockAltering()

virtual bool Atom::IQuartzQuantizedCommand::IsClockAltering ( )

inlinevirtual

Reimplemented in Atom::FQuantizedOtherClockStart, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

OnClockPaused()

void Atom::IQuartzQuantizedCommand::OnClockPaused

(

)

OnClockPausedCustom()

virtual void Atom::IQuartzQuantizedCommand::OnClockPausedCustom ( )

inlineprivatevirtual

OnClockStarted()

void Atom::IQuartzQuantizedCommand::OnClockStarted

(

)

OnClockStartedCustom()

virtual void Atom::IQuartzQuantizedCommand::OnClockStartedCustom ( )

inlineprivatevirtual

OnFinalCallback()

void Atom::IQuartzQuantizedCommand::OnFinalCallback

(

int32

InNumFramesLeft

)

OnFinalCallbackCustom()

virtual void Atom::IQuartzQuantizedCommand::OnFinalCallbackCustom ( int32 InNumFramesLeft )

inlineprivatevirtual

Reimplemented in Atom::FQuantizedOtherClockStart, Atom::FQuantizedPlayCommand, Atom::FQuantizedQueueCommand, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

OnQueued()

void Atom::IQuartzQuantizedCommand::OnQueued

(

const FQuartzQuantizedCommandInitInfo &

InCommandInitInfo

)

OnQueuedCustom()

virtual void Atom::IQuartzQuantizedCommand::OnQueuedCustom ( const FQuartzQuantizedCommandInitInfo & InCommandInitInfo )

inlineprivatevirtual

Reimplemented in Atom::FQuantizedNotify, Atom::FQuantizedOtherClockStart, Atom::FQuantizedPlayCommand, Atom::FQuantizedQueueCommand, Atom::FQuantizedTickRateChange, and Atom::FQuantizedTransportReset.

OnScheduled()

void Atom::IQuartzQuantizedCommand::OnScheduled

(

const Audio::FQuartzClockTickRate &

InTickRate

)

OverrideFramesUntilExec()

virtual int32 Atom::IQuartzQuantizedCommand::OverrideFramesUntilExec ( int32 NumFramesUntilExec )

inlinevirtual

Reimplemented in Atom::FQuantizedNotify, Atom::FQuantizedPlayCommand, and Atom::FQuantizedQueueCommand.

RequiresAtomRuntime()

virtual bool Atom::IQuartzQuantizedCommand::RequiresAtomRuntime ( ) const

inlinevirtual

Reimplemented in Atom::FQuantizedNotify, Atom::FQuantizedPlayCommand, and Atom::FQuantizedQueueCommand.

ShouldDeadlineIgnoresBpmChanges()

virtual bool Atom::IQuartzQuantizedCommand::ShouldDeadlineIgnoresBpmChanges ( )

inlinevirtual

Update()

void Atom::IQuartzQuantizedCommand::Update

(

int32

NumFramesUntilDeadline

)

Member Data Documentation

GameThreadDelegateID

int32 Atom::IQuartzQuantizedCommand::GameThreadDelegateID { -1 }

private

GameThreadSubscribers

TArray<Audio::FQuartzGameThreadSubscriber> Atom::IQuartzQuantizedCommand::GameThreadSubscribers

private

---

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

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