AST_VisNiagaraBase Class Reference

Abstract base class for visualisation actors that use Niagara systems. This class provides functionality for handling Niagara system initialization and management. More...

#include <ST_VisNiagaraBase.h>

Public Member Functions
	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	SetConstantParameters ()
virtual bool	SetDynamicParameters ()
Public Member Functions inherited from IST_AudioProcessingInterface
void	OnAudioIOStatusChanged (const bool bIsActive, const FIntPoint IOId)
	Event triggered when the status of an audio I/O device changes.
void	OnRawMagnitudesReady (const TArray< float > &RawMagnitudes, const FIntPoint IOId)
	Event triggered when raw magnitude data is ready for an audio I/O device.
void	OnFrequencyBandsReady (const TArray< float > &FrequencyBands, const int32 NumFrequencyBands, const FIntPoint IOId)
	Event triggered when frequency band data is ready for an audio I/O device.
void	OnAmplitudesReady (const TArray< float > &Amplitudes, const FIntPoint IOId)
	Event triggered when amplitude data is ready for an audio I/O device.
void	OnPitchesReady (const TArray< float > &Pitches, const FIntPoint IOId)
	Event triggered when pitch data is ready for an audio I/O device.
void	OnBeatDetected (const TArray< float > &Beats, const TArray< FChannelBeatDetection > &BeatDetectionForChannel, const FIntPoint IOId)
	Event triggered when a beat is detected in the audio data for an I/O device.

Protected Attributes
int32	Channel = 0
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

Additional Inherited Members
Protected Member Functions inherited from AST_VisBase
virtual void	PostInitializeComponents () override

Detailed Description

Abstract base class for visualisation actors that use Niagara systems. This class provides functionality for handling Niagara system initialization and management.

Constructor & Destructor Documentation

AST_VisNiagaraBase()

AST_VisNiagaraBase::AST_VisNiagaraBase

(

)

Default constructor for AST_VisNiagaraBase.

Member Function Documentation

HandleBeginPlay()

void AST_VisNiagaraBase::HandleBeginPlay ( )

overridevirtual

Called during the begin play phase of the actor's lifecycle. This override allows custom logic to be executed at the start.

Reimplemented from AST_VisBase.

SetNiagaraSystem()

void AST_VisNiagaraBase::SetNiagaraSystem

(

class UNiagaraSystem *

System

)

Sets the Niagara system for this actor.

Parameters

System

The Niagara system to assign.

Member Data Documentation

Channel

int32 AST_VisNiagaraBase::Channel = 0

protected

Which Channel Should be represented in the visualization. This value is clamped to the numChannels of the IO. This value is irrelevant when splitChannels is true.

Niagara

class UNiagaraComponent* AST_VisNiagaraBase::Niagara = nullptr

protected

Niagara component associated with this actor. This component is responsible for handling the Niagara system for visual effects.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Main/Base/ST_VisNiagaraBase.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Main/Base/ST_VisNiagaraBase.cpp