AST_N_VisFrequency Class Reference

AST_N_VisFrequency is a derived class from AST_VisNiagaraBase and implements INiagaraParticleCallbackHandler that handles frequency visualization. It handles frequency band visualization and interacts with Niagara systems to process and display particle data. This class is responsible for managing the frequency bands, receiving particle data, and broadcasting relevant data. More...

#include <ST_N_VisFrequency.h>

Public Member Functions
virtual void	ReceiveParticleData_Implementation (const TArray< FBasicParticleData > &Data, UNiagaraSystem *NiagaraSystem, const FVector &SimulationPositionOffset) override
Public Member Functions inherited from AST_VisNiagaraBase
	AST_VisNiagaraBase ()
virtual void	HandleBeginPlay () override
void	SetNiagaraSystem (class UNiagaraSystem *System)
Public Member Functions inherited from AST_VisBase
	AST_VisBase ()
virtual void	Tick (float DeltaTime) override
virtual void	BeginPlay () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override
virtual bool	RegisterToIO (EAudioIOType NewAudioIOType)
bool	RegisterToIO (int32 NewAudioIOType)
virtual void	DeregisterFromIO (EAudioIOType CurrAudioIOType)
void	DeregisterFromIO (int32 CurrAudioIOType)
virtual bool	SetDynamicParameters ()
Public Member Functions inherited from IST_AudioProcessingInterface
void	OnAudioIOStatusChanged (bool bIsActive, FIntPoint IOId)
	Event triggered when the status of an audio I/O device changes.
void	OnRawMagnitudesReady (const TArray< float > &RawMagnitudes, FIntPoint IOId)
	Event triggered when raw magnitude data is ready for an audio I/O device.
void	OnFrequencyBandsReady (const TArray< float > &FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId)
	Event triggered when frequency band data is ready for an audio I/O device.
void	OnAmplitudesReady (const TArray< float > &Amplitudes, FIntPoint IOId)
	Event triggered when amplitude data is ready for an audio I/O device.
void	OnPitchesReady (const TArray< float > &Pitches, FIntPoint IOId)
	Event triggered when pitch data is ready for an audio I/O device.
void	OnBeatDetected (const TArray< float > &Beats, const TArray< bool > &BeatDetectedForChannel, FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.

Public Attributes
FOnNiagaraDataAvailable	OnNiagaraDataAvailable

Protected Member Functions
virtual bool	SetConstantParameters () override
virtual void	OnFrequencyBandsReady_Implementation (const TArray< float > &FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId) override
virtual void	OnAudioIOStatusChanged_Implementation (bool bIsActive, FIntPoint IOId) override
Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

Additional Inherited Members
Protected Attributes inherited from AST_VisNiagaraBase
class UNiagaraComponent *	Niagara = nullptr
Protected Attributes inherited from AST_VisBase
USceneComponent *	Root = nullptr
bool	bCustomBeginPlay = false
bool	bSamplerActivates = false
bool	bZeroSamplersDeactivates = false
int32	Default_AudioIOs = 0
int32	Registered_AudioIOs = 0

Detailed Description

AST_N_VisFrequency is a derived class from AST_VisNiagaraBase and implements INiagaraParticleCallbackHandler that handles frequency visualization. It handles frequency band visualization and interacts with Niagara systems to process and display particle data. This class is responsible for managing the frequency bands, receiving particle data, and broadcasting relevant data.

Member Function Documentation

OnAudioIOStatusChanged_Implementation()

void AST_N_VisFrequency::OnAudioIOStatusChanged_Implementation ( bool bIsActive, FIntPoint IOId )

overrideprotectedvirtual

Called when the audio I/O status changes.

Parameters

bIsActive	Indicates if the audio I/O is active.
IOId	The identifier of the I/O operation whose status has changed.

OnFrequencyBandsReady_Implementation()

void AST_N_VisFrequency::OnFrequencyBandsReady_Implementation ( const TArray< float > & FrequencyBands, int32 NumFrequencyBands, FIntPoint IOId )

overrideprotectedvirtual

Called when the frequency bands are ready to be processed.

Parameters

FrequencyBands	The array of frequency band data.
NumFrequencyBands	The number of frequency bands.
IOId	The identifier of the I/O operation associated with the frequency data.

ReceiveParticleData_Implementation()

void AST_N_VisFrequency::ReceiveParticleData_Implementation ( const TArray< FBasicParticleData > & Data, UNiagaraSystem * NiagaraSystem, const FVector & SimulationPositionOffset )

overridevirtual

Callback function from INiagaraParticleCallbackHandler that receives particle data from a Niagara system.

Parameters

Data	The array of basic particle data received from the Niagara system.
NiagaraSystem	The Niagara system that generated the particle data.
SimulationPositionOffset	The offset applied to the simulation position.

SetConstantParameters()

bool AST_N_VisFrequency::SetConstantParameters ( )

overrideprotectedvirtual

Sets the constant parameters for the frequency visualization.

Returns

Returns true if the parameters were successfully set, false otherwise.

Reimplemented from AST_VisBase.

Member Data Documentation

OnNiagaraDataAvailable

FOnNiagaraDataAvailable AST_N_VisFrequency::OnNiagaraDataAvailable

Multicast delegate for broadcasting particle color data when available.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Niagara/Vis/ST_N_VisFrequency.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/Vis/ST_N_VisFrequency.cpp