SpatialSoundComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "SpatialSoundComponent.generated.h"
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent) )
class PROJECTX_API USpatialSoundComponent : public UActorComponent
{
    GENERATED_BODY()
 
public:
    /* Looping sound to play near and inside the volume */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    class USoundBase* Sound;
    /* Attenuation settings */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    class USoundAttenuation* AttenuationSettings;
    /* How often does the volume check for player proximity (per second) before activating itself? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    float InactiveTickInterval = 1.0f;
    /* How often does the volume update the sound position (per second) when the player is near? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    float ActiveTickInterval = 0.1f;
    /* How fast (in seconds) does the sound fade in as the player draws within attenuation range? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    float ActivationFadeInTime = 0.5f;
    /* Play the spatial sound anywhere except inside the box */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    bool bInvert = false;
    /* Does the box position or size ever change? If so, check this box */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    bool bIsDynamic = false;
    /* Visualize the position of the spatial sound volume and the moving sound within it */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = Sound)
    bool bShowDebug = false;
 
    USpatialSoundComponent();
 
    void Cleanup();
    void RecalculateBox(const bool bForce = false);
 
    virtual void BeginPlay() override;
    virtual void OnWorldOriginChanged(UWorld* World, FIntVector SizeX, FIntVector SizeY);
    virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
private:
    UPROPERTY()
    class UAudioComponent* AudioComponent;
    UPROPERTY()
    class UBoxComponent* BoxComponent;
 
    float FalloffSqured = 0.0f;
 
    FBox SoundAreaInfo;
 
    FVector GetSoundLocation(const AActor* const Listener) const;
    FVector GetNearestPointInPerimeter(const FVector& Point) const;
 
    void Optimize(const FVector& AudioComponentLocation, const AActor* const Listener);
};