ChaosVDOptionalDataChannel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_CHAOS_VISUAL_DEBUGGER
 
#include "Templates/SharedPointer.h"
#include "Delegates/Delegate.h"
 
class FText;
class FName;
 
enum class EChaosVDDataChannelInitializationFlags : uint8
{
    StartEnabled = 1 << 0,
    CanChangeEnabledState = 1 << 1
};
ENUM_CLASS_FLAGS(EChaosVDDataChannelInitializationFlags)
 
namespace Chaos::VisualDebugger
{
    struct FChaosVDOptionalDataChannel : TSharedFromThis<FChaosVDOptionalDataChannel>
    {
        explicit FChaosVDOptionalDataChannel(const TSharedRef<FName>& InChannelID, const TSharedRef<FText>& InDisplayName, EChaosVDDataChannelInitializationFlags InitializationFlags)
                : LocalizableChannelName(InDisplayName), ChannelId(InChannelID)
        {
            bIsEnabled = EnumHasAnyFlags(InitializationFlags, EChaosVDDataChannelInitializationFlags::StartEnabled);
            bCanChangeEnabledState = EnumHasAnyFlags(InitializationFlags, EChaosVDDataChannelInitializationFlags::CanChangeEnabledState);
        }
 
        void Initialize();
 
        CHAOS_API const FText& GetDisplayName() const;
 
        FName GetId() const
        {
            return *ChannelId;
        }
 
        FORCEINLINE bool IsChannelEnabled() const 
        { 
            return bIsEnabled;
        }
 
        CHAOS_API void SetChannelEnabled(bool bNewEnabled);
 
        bool CanChangeEnabledState() const 
        { 
            return bCanChangeEnabledState;
        }
 
    private:
        TSharedRef<FText> LocalizableChannelName;
        TSharedRef<FName> ChannelId;
        std::atomic<bool> bIsEnabled = true;
        bool bCanChangeEnabledState = false;
    };
 
    class FChaosVDDataChannelsManager
    {
    public:
 
        static CHAOS_API FChaosVDDataChannelsManager& Get();
 
        template<typename TCallback>
        void EnumerateChannels(TCallback Callback)
        {
            for (const TPair<FName, TSharedPtr<FChaosVDOptionalDataChannel>>& ChannelWithName : AvailableChannels)
            {
                if (!Callback(ChannelWithName.Value.ToSharedRef()))
                {
                    return;
                }
            }
        }
 
        TSharedPtr<FChaosVDOptionalDataChannel> GetChannelById(FName ChannelId)
        {
            if (TSharedPtr<FChaosVDOptionalDataChannel>* ChannelFound = AvailableChannels.Find(ChannelId))
            {
                return *ChannelFound;
            }
 
            return nullptr;
        }
 
    private:
 
        DECLARE_MULTICAST_DELEGATE_OneParam(FChannelStateChangedDelegate, TWeakPtr<FChaosVDOptionalDataChannel> DataChannelChanged);
        FChannelStateChangedDelegate ChannelStateChangedDelegate;
 
    public:
        FChannelStateChangedDelegate& OnChannelStateChanged()
        {
            return ChannelStateChangedDelegate;
        }
    private:
        
        void RegisterChannel(const TSharedRef<FChaosVDOptionalDataChannel>& NewChannel)
        {
            AvailableChannels.Add(NewChannel->GetId(), NewChannel);
        }
 
        TMap<FName, TSharedPtr<FChaosVDOptionalDataChannel>> AvailableChannels;
 
        friend FChaosVDOptionalDataChannel;
    };
 
    void ParseChannelListFromCommandArgument(TArray<FString>& OutParsedChannelList, const FString& InCommandArgument);
 
    CHAOS_API TSharedRef<FChaosVDOptionalDataChannel> CreateDataChannel(FName InChannelID, const TSharedRef<FText>& InDisplayName, EChaosVDDataChannelInitializationFlags InitializationFlags);
}
 
#endif //WITH_CHAOS_VISUAL_DEBUGGER
 
#ifndef CVD_CONCAT_NX
    #define CVD_CONCAT_NX(A, B) A ## B
#endif
 
#ifndef CVD_CONCAT
    #define CVD_CONCAT(A, B) CVD_CONCAT_NX(A,B)
#endif
 
#ifndef CVD_STRINGIZE_NX
    #define CVD_STRINGIZE_NX(A) #A
#endif
 
#ifndef CVD_STRINGIZE
    #define CVD_STRINGIZE(A) CVD_STRINGIZE_NX(A)
#endif
 
#if WITH_CHAOS_VISUAL_DEBUGGER
 
#ifndef CVD_DECLARE_OPTIONAL_DATA_CHANNEL
    #define CVD_DECLARE_OPTIONAL_DATA_CHANNEL(DataChannelName) \
            extern CHAOS_API TSharedRef<Chaos::VisualDebugger::FChaosVDOptionalDataChannel> CVDDC_##DataChannelName;
#endif
 
#ifndef CVD_DECLARE_OPTIONAL_DATA_CHANNEL_EXTERN
    #define CVD_DECLARE_OPTIONAL_DATA_CHANNEL_EXTERN(DataChannelName, ModuleAPI) \
        extern ModuleAPI TSharedRef<Chaos::VisualDebugger::FChaosVDOptionalDataChannel> CVDDC_##DataChannelName;
#endif
 
#ifndef CVD_DEFINE_OPTIONAL_DATA_CHANNEL
    #define CVD_DEFINE_OPTIONAL_DATA_CHANNEL(DataChannelName, InitializationFlags) \
            TSharedRef<Chaos::VisualDebugger::FChaosVDOptionalDataChannel> CVDDC_##DataChannelName = Chaos::VisualDebugger::CreateDataChannel(#DataChannelName, MakeShared<FText>(NSLOCTEXT(CVD_STRINGIZE(ChaosVisualDebugger), CVD_STRINGIZE(CVD_CONCAT(DataChannelName,_ChannelName)), #DataChannelName)), InitializationFlags);
#endif
 
 
// Declare CVD's Default set of channels
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(Default);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(EvolutionStart);                          // Initial particle positions for this tick. Same as end of previous EvolutionEnd but with any external changes applied (set position, velocity, etc).
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(PostIntegrate);                           // Predicted particle positions before user callbacks and constraint solver. Includes this tick's movement from external forces, velocity, kinematic targets, etc.
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(PreConstraintSolve);                      // Predicted particle positions as used by the constraint solver. After user callbacks, collision modifiers, etc., but before collisions and joints are resolved.
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(CollisionDetectionBroadPhase);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(CollisionDetectionNarrowPhase);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(EndOfEvolutionCollisionConstraints);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(PostConstraintSolve);                     // Particle positions corrected by the constraint solver (collisions, joints, etc.), but before user callbacks or destruction handling.
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(EvolutionEnd);                            // Final particle positions, including destruction and user callbacks.
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(SceneQueries);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(JointLinearConstraints);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(JointNonLinearConstraints);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(CharacterGroundConstraints);
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(AccelerationStructures);
 
// When a particle is added to a cluster will get disabled and therefore not updated by CVD's delta frames implementation.
// If this channel is enabled, we will record all child particles of any active dirty cluster particle
CVD_DECLARE_OPTIONAL_DATA_CHANNEL(ClusterParticlesChildData);
 
#else  //WITH_CHAOS_VISUAL_DEBUGGER
 
#ifndef CVD_DECLARE_OPTIONAL_DATA_CHANNEL
    #define CVD_DECLARE_OPTIONAL_DATA_CHANNEL(DataChannelName)
#endif
 
#ifndef CVD_DECLARE_OPTIONAL_DATA_CHANNEL_EXTERN
    #define CVD_DECLARE_OPTIONAL_DATA_CHANNEL_EXTERN(DataChannelName, ModuleAPI)
#endif
 
#ifndef CVD_DEFINE_OPTIONAL_DATA_CHANNEL
    #define CVD_DEFINE_OPTIONAL_DATA_CHANNEL(DataChannelName, InitializationFlags)
#endif
 
#endif  //WITH_CHAOS_VISUAL_DEBUGGER