SpectrumAnalyzer Class Reference

A material that visualizes audio data as a spectrum. More...

#include <SpectrumAnalyzer.h>

Inheritance diagram for SpectrumAnalyzer:

Collaboration diagram for SpectrumAnalyzer:

Public Member Functions
	SpectrumAnalyzer (Vector2D size, Vector2D offset, bool bounce=false, bool flipY=false, bool mirrorY=false)
	Constructor for SpectrumAnalyzer.
	~SpectrumAnalyzer ()
	Destructor for SpectrumAnalyzer.
void	SetMirrorYState (bool state)
	Sets the mirroring state for the visualization.
void	SetFlipYState (bool state)
	Sets the flipping state for the visualization.
void	SetMaterial (Material *material)
	Sets a custom material for additional effects.
float *	GetFourierData ()
	Retrieves the Fourier data used for visualization.
void	SetSize (Vector2D size)
	Sets the size of the visualization area.
void	SetPosition (Vector2D offset)
	Sets the position of the visualization area.
void	SetRotation (float angle)
	Sets the rotation angle of the visualization.
void	SetHueAngle (float hueAngle)
	Sets the hue adjustment angle for the spectrum colors.
void	Update (float *readData)
	Updates the spectrum visualization with new audio data.
RGBColor	GetRGB (const Vector3D &position, const Vector3D &normal, const Vector3D &uvw) override
	Computes the color at a given position in the material.
Public Member Functions inherited from Material
virtual	~Material ()=default
	Virtual destructor for proper cleanup in derived classes.

Private Attributes
BouncePhysics *	bPhy [128]
	Array of bounce physics objects for each frequency bin.
Vector2D	size
	Size of the visualization area.
Vector2D	offset
	Offset position of the visualization area.
float	angle = 0.0f
	Rotation angle of the visualization.
float	hueAngle = 0.0f
	Hue adjustment angle for the spectrum colors.
uint8_t	colors
	Number of colors in the gradient.
float *	data
	Pointer to the input audio data.
float	bounceData [128]
	Processed bounce data for visualization.
uint8_t	bins = 128
	Number of frequency bins.
bool	mirrorY = false
	Whether to mirror the visualization along the Y-axis.
bool	flipY = false
	Whether to flip the visualization along the Y-axis.
bool	bounce = false
	Whether to apply bouncing animation to the spectrum.
RGBColor	rainbowSpectrum [6]
	Predefined rainbow color gradient.
GradientMaterial< 6 >	gM = GradientMaterial<6>(rainbowSpectrum, 1.0f, false)
	Gradient material for coloring the spectrum.
Material *	material
	Optional sub-material for additional effects.

Additional Inherited Members
Public Types inherited from Material
enum	Method {   Base , Add , Subtract , Multiply ,   Divide , Darken , Lighten , Screen ,   Overlay , SoftLight , Replace , EfficientMask ,   Bypass }
	Defines blending methods for combining colors. More...

Detailed Description

A material that visualizes audio data as a spectrum.

The SpectrumAnalyzer class processes audio data to create a colorful and dynamic spectrum visualization with options for customization, including mirroring and flipping.

Definition at line 25 of file SpectrumAnalyzer.h.

Constructor & Destructor Documentation

SpectrumAnalyzer()

SpectrumAnalyzer	(	Vector2D	size,
		Vector2D	offset,
		bool	bounce = false,
		bool	flipY = false,
		bool	mirrorY = false
	)

Constructor for SpectrumAnalyzer.

Parameters

size	The size of the visualization area.
offset	The offset position of the visualization.
bounce	Enables bouncing animation for the spectrum.
flipY	Enables flipping the visualization along the Y-axis.
mirrorY	Enables mirroring the visualization along the Y-axis.

Definition at line 3 of file SpectrumAnalyzer.cpp.

References bounce, bPhy, Vector2D::Divide(), flipY, gM, material, mirrorY, offset, and size.

~SpectrumAnalyzer()

~SpectrumAnalyzer

(

)

Destructor for SpectrumAnalyzer.

Definition at line 18 of file SpectrumAnalyzer.cpp.

References bPhy.

Member Function Documentation

GetFourierData()

float * GetFourierData

(

)

Retrieves the Fourier data used for visualization.

Returns

Pointer to the array of Fourier data.

Definition at line 36 of file SpectrumAnalyzer.cpp.

References bounce, bounceData, and data.

GetRGB()

RGBColor GetRGB ( const Vector3D &  position, const Vector3D &  normal, const Vector3D &  uvw  )

overridevirtual

Computes the color at a given position in the material.

Parameters

position	The position in 3D space.
normal	The surface normal vector.
uvw	The texture coordinates.

Returns

The computed color as an RGBColor.

Implements Material.

Definition at line 72 of file SpectrumAnalyzer.cpp.

References angle, bins, bounce, bounceData, Mathematics::CosineInterpolation(), data, flipY, Material::GetRGB(), hueAngle, RGBColor::HueShift(), Mathematics::IsClose(), Mathematics::Map(), material, mirrorY, offset, Vector2D::Rotate(), size, Vector2D::X, Vector3D::X, Vector2D::Y, and Vector3D::Y.

SetFlipYState()

void SetFlipYState

(

bool

state

)

Sets the flipping state for the visualization.

Parameters

state

True to enable flipping along the Y-axis, false to disable.

Definition at line 28 of file SpectrumAnalyzer.cpp.

References flipY.

Referenced by AphoriAnimation::Update(), ArtleckAnimationV2::Update(), BasilGardenAnimation::Update(), BroookAnimation::Update(), ElGatoAnimation::Update(), GalaxyAnimation::Update(), HertzzAnimation::Update(), InfraredAnimation::Update(), LeonHuskyAnimation::Update(), MyntAnimation::Update(), ProtobottAnimation::Update(), SammyAnimation::Update(), SergaliciousAnimation::Update(), StrawberryAnimation::Update(), TamamoAnimation::Update(), TechSaneAnimation::Update(), VesperAnimation::Update(), WaffleDaProtoAnimation::Update(), WarzoneAnimation::Update(), Warzone2Animation::Update(), XenraxAnimation::Update(), AlphaAnimation::Update(), GammaAnimation::Update(), HUB75AnimationSplit::Update(), WS35AnimationSplit::Update(), and ProtogenProject::UpdateFace().

SetHueAngle()

void SetHueAngle

(

float

hueAngle

)

Sets the hue adjustment angle for the spectrum colors.

Parameters

hueAngle

The hue adjustment angle in degrees.

Definition at line 56 of file SpectrumAnalyzer.cpp.

References hueAngle.

Referenced by AphoriAnimation::Update(), ArtleckAnimationV2::Update(), BasilGardenAnimation::Update(), BroookAnimation::Update(), ElGatoAnimation::Update(), GalaxyAnimation::Update(), HertzzAnimation::Update(), InfraredAnimation::Update(), LeonHuskyAnimation::Update(), MyntAnimation::Update(), ProtobottAnimation::Update(), SammyAnimation::Update(), SergaliciousAnimation::Update(), StrawberryAnimation::Update(), TamamoAnimation::Update(), TechSaneAnimation::Update(), VesperAnimation::Update(), WaffleDaProtoAnimation::Update(), WarzoneAnimation::Update(), Warzone2Animation::Update(), XenraxAnimation::Update(), AlphaAnimation::Update(), GammaAnimation::Update(), HUB75AnimationSplit::Update(), WS35AnimationSplit::Update(), and ProtogenProject::UpdateFace().

SetMaterial()

void SetMaterial

(

Material *

material

)

Sets a custom material for additional effects.

Parameters

material

Pointer to the custom material.

Definition at line 32 of file SpectrumAnalyzer.cpp.

References material.

SetMirrorYState()

void SetMirrorYState

(

bool

state

)

Sets the mirroring state for the visualization.

Parameters

state

True to enable mirroring along the Y-axis, false to disable.

Definition at line 24 of file SpectrumAnalyzer.cpp.

References mirrorY.

Referenced by AphoriAnimation::Update(), ArtleckAnimationV2::Update(), BasilGardenAnimation::Update(), BroookAnimation::Update(), ElGatoAnimation::Update(), GalaxyAnimation::Update(), HertzzAnimation::Update(), InfraredAnimation::Update(), LeonHuskyAnimation::Update(), MyntAnimation::Update(), ProtobottAnimation::Update(), SammyAnimation::Update(), SergaliciousAnimation::Update(), StrawberryAnimation::Update(), TamamoAnimation::Update(), TechSaneAnimation::Update(), VesperAnimation::Update(), WaffleDaProtoAnimation::Update(), WarzoneAnimation::Update(), Warzone2Animation::Update(), XenraxAnimation::Update(), AlphaAnimation::Update(), GammaAnimation::Update(), HUB75AnimationSplit::Update(), WS35AnimationSplit::Update(), and ProtogenProject::UpdateFace().

SetPosition()

void SetPosition

(

Vector2D

offset

)

Sets the position of the visualization area.

Parameters

offset

The new position as a Vector2D.

Definition at line 48 of file SpectrumAnalyzer.cpp.

References offset.

Referenced by ProtogenProject::ProtogenProject().

SetRotation()

void SetRotation

(

float

angle

)

Sets the rotation angle of the visualization.

Parameters

angle

The rotation angle in degrees.

Definition at line 52 of file SpectrumAnalyzer.cpp.

References angle.

Referenced by AlphaAnimation::Update().

SetSize()

void SetSize

(

Vector2D

size

)

Sets the size of the visualization area.

Parameters

size	The new size as a Vector2D.

Definition at line 44 of file SpectrumAnalyzer.cpp.

References Vector2D::Divide(), and size.

Referenced by ProtogenProject::ProtogenProject().

Update()

void Update

(

float *

readData

)

Updates the spectrum visualization with new audio data.

Parameters

readData

Pointer to the new audio data.

Definition at line 60 of file SpectrumAnalyzer.cpp.

References bounce, bounceData, bPhy, BouncePhysics::Calculate(), and data.

Referenced by ProtogenProject::SpectrumAnalyzerFace(), AphoriAnimation::Update(), ArtleckAnimationV2::Update(), BasilGardenAnimation::Update(), BroookAnimation::Update(), ElGatoAnimation::Update(), HertzzAnimation::Update(), InfraredAnimation::Update(), LeonHuskyAnimation::Update(), MyntAnimation::Update(), ProtobottAnimation::Update(), SammyAnimation::Update(), SergaliciousAnimation::Update(), StrawberryAnimation::Update(), TamamoAnimation::Update(), TechSaneAnimation::Update(), VesperAnimation::Update(), WaffleDaProtoAnimation::Update(), WarzoneAnimation::Update(), Warzone2Animation::Update(), XenraxAnimation::Update(), AlphaAnimation::Update(), GammaAnimation::Update(), HUB75AnimationSplit::Update(), and WS35AnimationSplit::Update().

Member Data Documentation

angle

float angle = 0.0f

private

Rotation angle of the visualization.

Definition at line 30 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), and SetRotation().

bins

uint8_t bins = 128

private

Number of frequency bins.

Definition at line 35 of file SpectrumAnalyzer.h.

Referenced by GetRGB().

bounce

bool bounce = false

private

Whether to apply bouncing animation to the spectrum.

Definition at line 38 of file SpectrumAnalyzer.h.

Referenced by GetFourierData(), GetRGB(), SpectrumAnalyzer(), and Update().

bounceData

float bounceData[128]

private

Processed bounce data for visualization.

Definition at line 34 of file SpectrumAnalyzer.h.

Referenced by GetFourierData(), GetRGB(), and Update().

bPhy

BouncePhysics* bPhy[128]

private

Array of bounce physics objects for each frequency bin.

Definition at line 27 of file SpectrumAnalyzer.h.

Referenced by SpectrumAnalyzer(), Update(), and ~SpectrumAnalyzer().

colors

uint8_t colors

private

Number of colors in the gradient.

Definition at line 32 of file SpectrumAnalyzer.h.

data

float* data

private

Pointer to the input audio data.

Definition at line 33 of file SpectrumAnalyzer.h.

Referenced by GetFourierData(), GetRGB(), and Update().

flipY

bool flipY = false

private

Whether to flip the visualization along the Y-axis.

Definition at line 37 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), SetFlipYState(), and SpectrumAnalyzer().

gM

GradientMaterial<6> gM = GradientMaterial<6>(rainbowSpectrum, 1.0f, false)

private

Gradient material for coloring the spectrum.

Definition at line 49 of file SpectrumAnalyzer.h.

Referenced by SpectrumAnalyzer().

hueAngle

float hueAngle = 0.0f

private

Hue adjustment angle for the spectrum colors.

Definition at line 31 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), and SetHueAngle().

material

Material* material

private

Optional sub-material for additional effects.

Definition at line 50 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), SetMaterial(), and SpectrumAnalyzer().

mirrorY

bool mirrorY = false

private

Whether to mirror the visualization along the Y-axis.

Definition at line 36 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), SetMirrorYState(), and SpectrumAnalyzer().

offset

Vector2D offset

private

Offset position of the visualization area.

Definition at line 29 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), SetPosition(), and SpectrumAnalyzer().

rainbowSpectrum

RGBColor rainbowSpectrum[6]

private

Initial value:

= {
        RGBColor(255, 0, 0), 
        RGBColor(255, 255, 0), 
        RGBColor(0, 255, 0), 
        RGBColor(0, 255, 255), 
        RGBColor(0, 0, 255), 
        RGBColor(255, 0, 255)
    }

Predefined rainbow color gradient.

Definition at line 40 of file SpectrumAnalyzer.h.

size

Vector2D size

private

Size of the visualization area.

Definition at line 28 of file SpectrumAnalyzer.h.

Referenced by GetRGB(), SetSize(), and SpectrumAnalyzer().

---

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

• SpectrumAnalyzer.h
• SpectrumAnalyzer.cpp