SoundNodeDistanceCrossFade.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Sound/SoundNode.h"
#include "SoundNodeDistanceCrossFade.generated.h"
 
class FAudioDevice;
struct FActiveSound;
struct FSoundParseParameters;
struct FWaveInstance;
 
USTRUCT()
struct FDistanceDatum
{
    GENERATED_USTRUCT_BODY()
 
    /* The FadeInDistance at which to start hearing this sound.
     * If you want to hear the sound up close then setting this to 0 might be a good option. 
     */
    UPROPERTY(EditAnywhere, Category=DistanceDatum )
    float FadeInDistanceStart;
 
    /* The distance at which this sound has faded in completely. */
    UPROPERTY(EditAnywhere, Category=DistanceDatum )
    float FadeInDistanceEnd;
 
    /* The distance at which this sound starts fading out. */
    UPROPERTY(EditAnywhere, Category=DistanceDatum )
    float FadeOutDistanceStart;
 
    /* The distance at which this sound is no longer audible. */
    UPROPERTY(EditAnywhere, Category=DistanceDatum )
    float FadeOutDistanceEnd;
 
    /* The volume for which this Input should be played. */
    UPROPERTY(EditAnywhere, Category=DistanceDatum)
    float Volume;
 
 
        FDistanceDatum()
        : FadeInDistanceStart(0)
        , FadeInDistanceEnd(0)
        , FadeOutDistanceStart(0)
        , FadeOutDistanceEnd(0)
        , Volume(1.0f)
        {
        }
    
};
 
UCLASS(hidecategories=Object, editinlinenew, MinimalAPI, meta=( DisplayName="Crossfade by Distance" ))
class USoundNodeDistanceCrossFade : public USoundNode
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, export, editfixedsize, Category=CrossFade)
    TArray<struct FDistanceDatum> CrossFadeInput;
 
 
public:
    //~ Begin USoundNode Interface. 
    virtual void ParseNodes( FAudioDevice* AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound, const FSoundParseParameters& ParseParams, TArray<FWaveInstance*>& WaveInstances ) override;
    virtual int32 GetMaxChildNodes() const override 
    { 
        return MAX_ALLOWED_CHILD_NODES;  
    }
    virtual void CreateStartingConnectors( void ) override;
    virtual void InsertChildNode( int32 Index ) override;
    virtual void RemoveChildNode( int32 Index ) override;
#if WITH_EDITOR
    virtual void SetChildNodes(TArray<USoundNode*>& InChildNodes) override;
#endif //WITH_EDITOR
    virtual float GetMaxDistance() const override;
    virtual int32 GetNumSounds(const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound) const;
    //~ End USoundNode Interface. 
 
    virtual float GetCurrentDistance(FAudioDevice* AudioDevice, FActiveSound& ActiveSound, const FSoundParseParameters& ParseParams) const;
 
    virtual bool AllowCrossfading(FActiveSound& ActiveSound) const;
};