You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
6653455ac2
- created a dedicated option to auto-scroll and converted debugger pause to control event processing - clear tracks when selecting new valid session - scrub buttons can now be used as soon as analysis is pause of auto-scroll disabled - fixed potential access to invalid struct view when processing a FStateTreeTraceNodeEvent - added return value and output parameter to IStateTreeModule::StartTraces to take appropriate actions if traces was already active or not. - added new button to the DebuggerView to control the session analysis state (pause or not). Mainly required when performing a remove analysis of non editor target. - added new button to the DebuggerView to toggle auto-scroll. Manual selection in the timeline will turn it off so it can now be turned back on. #rb mikko.mononen [CL 26188376 by yoan stamant in ue5-main branch]
75 lines
2.2 KiB
C++
75 lines
2.2 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Modules/ModuleManager.h"
|
|
|
|
namespace UE::Trace
|
|
{
|
|
class FStoreClient;
|
|
}
|
|
|
|
/**
|
|
* The public interface to this module
|
|
*/
|
|
class IStateTreeModule : public IModuleInterface
|
|
{
|
|
|
|
public:
|
|
|
|
/**
|
|
* Singleton-like access to this module's interface. This is just for convenience!
|
|
* Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
|
|
*
|
|
* @return Returns singleton instance, loading the module on demand if needed
|
|
*/
|
|
static IStateTreeModule& Get()
|
|
{
|
|
return FModuleManager::LoadModuleChecked<IStateTreeModule>("StateTreeModule");
|
|
}
|
|
|
|
/**
|
|
* Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.
|
|
*
|
|
* @return True if the module is loaded and ready to use
|
|
*/
|
|
static bool IsAvailable()
|
|
{
|
|
return FModuleManager::Get().IsModuleLoaded("StateTreeModule");
|
|
}
|
|
|
|
/**
|
|
* Creates new tracing connection if necessary and enables StateTree debugging related channels (frame + statetree).
|
|
* If traces are already active we keep track of all channels previously activated to restore them on stop.
|
|
* @param OutTraceId In case a connection is already active this indicates its id, 0 otherwise.
|
|
* @return True if a new trace connection was created, false otherwise (already active or not created)
|
|
* @note Even if it returns false this can still have enabled StateTree related channels, OutTraceId will indicate
|
|
* which trace to use and StopTraces should be called to restore to previous setup.
|
|
*/
|
|
virtual bool StartTraces(int32& OutTraceId) = 0;
|
|
|
|
/**
|
|
* Stops the trace service if it was not already connected when StartTraces was called.
|
|
* Restores previously enabled channels if necessary.
|
|
*/
|
|
virtual void StopTraces() = 0;
|
|
|
|
/**
|
|
* Indicates if the statetree specific traces are active (explicitly started by StartTraces).
|
|
* @return True is StartTraces was called, false otherwise.
|
|
*/
|
|
virtual bool IsTracing() const = 0;
|
|
|
|
#if WITH_STATETREE_DEBUGGER
|
|
/**
|
|
* Gets the store client.
|
|
*/
|
|
virtual UE::Trace::FStoreClient* GetStoreClient() = 0;
|
|
#endif // WITH_STATETREE_DEBUGGER
|
|
};
|
|
|
|
|
|
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_2
|
|
#include "CoreMinimal.h"
|
|
#endif
|