SoundNodeRandom.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 "SoundNodeRandom.generated.h"
 
class FAudioDevice;
struct FActiveSound;
struct FSoundParseParameters;
struct FWaveInstance;
 
UCLASS(hidecategories=Object, editinlinenew, MinimalAPI, meta=( DisplayName="Random" ))
class USoundNodeRandom : public USoundNode
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY(EditAnywhere, editfixedsize, Category=Random)
    TArray<float> Weights;
 
    UPROPERTY(transient)
    TArray<bool> HasBeenUsed;
 
    UPROPERTY(transient)
    int32 NumRandomUsed;
 
    UPROPERTY(EditAnywhere, Category=Random)
    int32 PreselectAtLevelLoad;
 
    UPROPERTY(EditAnywhere, Category = Random)
    uint8 bShouldExcludeFromBranchCulling : 1;
 
    UPROPERTY()
    uint8 bSoundCueExcludedFromBranchCulling : 1;
 
    UPROPERTY(EditAnywhere, Category=Random)
    uint8 bRandomizeWithoutReplacement : 1;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    TArray<int32> PIEHiddenNodes;
#endif //WITH_EDITORONLY_DATA
 
public:
    //~ Begin UObject Interface
    virtual void PostLoad() override;
    virtual void PostEditImport() override;
    //~ End UObject Interface
 
    //~ Begin USoundNode Interface.
    virtual void ParseNodes( FAudioDevice* AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound, const FSoundParseParameters& ParseParams, TArray<FWaveInstance*>& WaveInstances ) override;
    virtual int32 GetNumSounds(const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound) const override;
    virtual int32 GetMaxChildNodes() const override 
    { 
        return MAX_ALLOWED_CHILD_NODES; 
    }
    virtual void InsertChildNode( int32 Index ) override;
    virtual void RemoveChildNode( int32 Index ) override;
#if WITH_EDITOR
    virtual void SetChildNodes(TArray<USoundNode*>& InChildNodes) override;
    virtual void OnBeginPIE(const bool bIsSimulating) override;
#endif //WITH_EDITOR
    virtual void CreateStartingConnectors( void ) override;
    //~ End USoundNode Interface.
 
    // @todo document
    void FixWeightsArray( void );
 
    // @todo document
    void FixHasBeenUsedArray( void );
 
#if WITH_EDITOR
    void UpdatePIEHiddenNodes();
#endif //WITH_EDITOR
 
    int32 ChooseNodeIndex(FActiveSound& ActiveSound);
 
private:
 
    /*
     * Determines the amount of branches to use on this random node, so that we can cull the rest.
     * Based on the au.MaxRandomBranches CVar, the MaxNumRandomBranches project setting
     * available for some platforms, and this node's PreselectAtLevelLoad FProperty.
     * @return 0 if we do not want cull any branches.
     */
    int32 DetermineAmountOfBranchesToPreselect();
 
};