You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
511 lines
18 KiB
C++
511 lines
18 KiB
C++
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "Styling/SlateColor.h"
|
|
#include "Rendering/SlateLayoutTransform.h"
|
|
#include "Layout/Geometry.h"
|
|
#include "Widgets/SNullWidget.h"
|
|
#include "Layout/ArrangedWidget.h"
|
|
#include "AssetData.h"
|
|
|
|
class FJsonValue;
|
|
class FWidgetPath;
|
|
class SWidget;
|
|
|
|
/**
|
|
* Enum used as crude RTTI for the widget reflector node types
|
|
*/
|
|
enum class EWidgetReflectorNodeType : uint8
|
|
{
|
|
Live,
|
|
Snapshot,
|
|
};
|
|
|
|
/**
|
|
* Cached information about whether a widget can be hit-tested
|
|
*/
|
|
struct FWidgetHitTestInfo
|
|
{
|
|
bool IsHitTestVisible;
|
|
bool AreChildrenHitTestVisible;
|
|
};
|
|
|
|
/**
|
|
* A widget reflector node that contains the interface and basic data required by both live and snapshot nodes
|
|
*/
|
|
class FWidgetReflectorNodeBase
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~FWidgetReflectorNodeBase() {}
|
|
|
|
/**
|
|
* @return Get the enum entry corresponding to this type of widget reflector node (used as crude RTTI)
|
|
*/
|
|
virtual EWidgetReflectorNodeType GetNodeType() const = 0;
|
|
|
|
/**
|
|
* @note This function only works for ULiveWidgetReflectorNode instances
|
|
* @return The live widget that this node is referencing
|
|
*/
|
|
virtual TSharedPtr<SWidget> GetLiveWidget() const = 0;
|
|
|
|
/**
|
|
* @return The type string for the widget we were initialized from
|
|
*/
|
|
virtual FText GetWidgetType() const = 0;
|
|
|
|
/**
|
|
* @return The type string for the widget we were initialized from
|
|
*/
|
|
virtual FText GetWidgetTypeAndShortName() const = 0;
|
|
|
|
/**
|
|
* @return The visibility string for the widget we were initialized from
|
|
*/
|
|
virtual FText GetWidgetVisibilityText() const = 0;
|
|
|
|
/**
|
|
* @return The clipping string for the widget we were initialized from
|
|
*/
|
|
virtual FText GetWidgetClippingText() const = 0;
|
|
|
|
/**
|
|
* @return The bool indicating whether or not the widget we were initialized from reports as Focusable
|
|
*/
|
|
virtual bool GetWidgetFocusable() const = 0;
|
|
|
|
/** Is the widget visible? */
|
|
virtual bool GetWidgetVisible() const = 0;
|
|
|
|
virtual bool GetWidgetNeedsTick() const = 0;
|
|
virtual bool GetWidgetIsVolatile() const = 0;
|
|
virtual bool GetWidgetIsVolatileIndirectly() const = 0;
|
|
virtual bool GetWidgetHasActiveTimers() const = 0;
|
|
|
|
/**
|
|
* The human readable location for widgets that are defined in C++ is the file and line number
|
|
* The human readable location for widgets that are defined in UMG is the asset name
|
|
* @return The fully human readable location for the widget we were initialized from
|
|
*/
|
|
virtual FText GetWidgetReadableLocation() const = 0;
|
|
|
|
/**
|
|
* @return The name of the file that the widget we were initialized from was created from (for C++ widgets)
|
|
*/
|
|
virtual FString GetWidgetFile() const = 0;
|
|
|
|
/**
|
|
* @return The line number of the file that the widget we were initialized from was created from (for C++ widgets)
|
|
*/
|
|
virtual int32 GetWidgetLineNumber() const = 0;
|
|
|
|
/**
|
|
* @return The data of the asset that the widget we were initialized from was created from (for UMG widgets)
|
|
*/
|
|
virtual FAssetData GetWidgetAssetData() const = 0;
|
|
|
|
/**
|
|
* @return The desired size of the widget we were initialized from
|
|
*/
|
|
virtual FVector2D GetWidgetDesiredSize() const = 0;
|
|
|
|
/**
|
|
* @return The foreground color of the widget we were initialized from
|
|
*/
|
|
virtual FSlateColor GetWidgetForegroundColor() const = 0;
|
|
|
|
/**
|
|
* @return The in-memory address of the widget we were initialized from
|
|
*/
|
|
virtual FString GetWidgetAddress() const = 0;
|
|
|
|
/**
|
|
* @return True if the the widget we were initialized from is enabled, false otherwise
|
|
*/
|
|
virtual bool GetWidgetEnabled() const = 0;
|
|
|
|
/**
|
|
* @return True if the widget is live, and local and can potentially be manipulated in real-time.
|
|
*/
|
|
virtual bool IsWidgetLive() const = 0;
|
|
|
|
/**
|
|
* @return The geometry of the widget.
|
|
*/
|
|
const FGeometry& GetGeometry() const;
|
|
|
|
/**
|
|
* @return The accumulated layout transform of the widget we were initialized from
|
|
*/
|
|
FSlateLayoutTransform GetAccumulatedLayoutTransform() const;
|
|
|
|
/**
|
|
* @return The accumulated render transform of the widget we were initialized from
|
|
*/
|
|
const FSlateRenderTransform& GetAccumulatedRenderTransform() const;
|
|
|
|
/**
|
|
* @return The local size of the widget we were initialized from
|
|
*/
|
|
const FVector2D& GetLocalSize() const;
|
|
|
|
/**
|
|
* @return The basic hit-test of the widget we were initialized from
|
|
*/
|
|
const FWidgetHitTestInfo& GetHitTestInfo() const;
|
|
|
|
/**
|
|
* @return The tint that is applied to text in order to provide visual hints
|
|
*/
|
|
const FLinearColor& GetTint() const;
|
|
|
|
/**
|
|
* Set the tint to the given value
|
|
*/
|
|
void SetTint(const FLinearColor& InTint);
|
|
|
|
/**
|
|
* Add the given node to our list of children for this widget (this node will keep a strong reference to the instance)
|
|
*/
|
|
void AddChildNode(TSharedRef<FWidgetReflectorNodeBase> InChildNode);
|
|
|
|
/**
|
|
* @return The node entries for the widget's children
|
|
*/
|
|
const TArray<TSharedRef<FWidgetReflectorNodeBase>>& GetChildNodes() const;
|
|
|
|
protected:
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
FWidgetReflectorNodeBase();
|
|
|
|
/**
|
|
* Construct this node from the given widget geometry, caching out any data that may be required for future visualization in the widget reflector
|
|
*/
|
|
explicit FWidgetReflectorNodeBase(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
protected:
|
|
/** The Geometry of the widget. */
|
|
FGeometry WidgetGeometry;
|
|
|
|
/** The hit-test information for the widget */
|
|
FWidgetHitTestInfo HitTestInfo;
|
|
|
|
/** Node entries for the widget's children */
|
|
TArray<TSharedRef<FWidgetReflectorNodeBase>> ChildNodes;
|
|
|
|
/** A tint that is applied to text in order to provide visual hints (Transient) */
|
|
FLinearColor Tint;
|
|
};
|
|
|
|
/**
|
|
* A widget reflector node that holds on to the widget it references so that certain properties can be updated live
|
|
*/
|
|
class FLiveWidgetReflectorNode : public FWidgetReflectorNodeBase
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~FLiveWidgetReflectorNode() {}
|
|
|
|
/**
|
|
* Create a live node instance from the given widget geometry, caching out any data that may be required for future visualization in the widget reflector
|
|
*/
|
|
static TSharedRef<FLiveWidgetReflectorNode> Create(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
// FWidgetReflectorNodeBase interface
|
|
virtual EWidgetReflectorNodeType GetNodeType() const override;
|
|
virtual TSharedPtr<SWidget> GetLiveWidget() const override;
|
|
virtual FText GetWidgetType() const override;
|
|
virtual FText GetWidgetTypeAndShortName() const override;
|
|
virtual FText GetWidgetVisibilityText() const override;
|
|
virtual bool GetWidgetVisible() const override;
|
|
virtual FText GetWidgetClippingText() const override;
|
|
virtual bool GetWidgetFocusable() const override;
|
|
virtual bool GetWidgetNeedsTick() const override;
|
|
virtual bool GetWidgetIsVolatile() const override;
|
|
virtual bool GetWidgetIsVolatileIndirectly() const override;
|
|
virtual bool GetWidgetHasActiveTimers() const override;
|
|
virtual FText GetWidgetReadableLocation() const override;
|
|
virtual FString GetWidgetFile() const override;
|
|
virtual int32 GetWidgetLineNumber() const override;
|
|
virtual FAssetData GetWidgetAssetData() const override;
|
|
virtual FVector2D GetWidgetDesiredSize() const override;
|
|
virtual FSlateColor GetWidgetForegroundColor() const override;
|
|
virtual FString GetWidgetAddress() const override;
|
|
virtual bool GetWidgetEnabled() const override;
|
|
virtual bool IsWidgetLive() const override { return true; }
|
|
|
|
private:
|
|
/**
|
|
* Construct this node from the given widget geometry, caching out any data that may be required for future visualization in the widget reflector
|
|
*/
|
|
explicit FLiveWidgetReflectorNode(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
private:
|
|
/** The widget this node is watching */
|
|
TWeakPtr<SWidget> Widget;
|
|
};
|
|
|
|
/**
|
|
* A widget reflector node that holds the widget information from a snapshot at a given point in time
|
|
*/
|
|
class FSnapshotWidgetReflectorNode : public FWidgetReflectorNodeBase
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~FSnapshotWidgetReflectorNode() {}
|
|
|
|
/**
|
|
* Create a default snapshot node instance
|
|
*/
|
|
static TSharedRef<FSnapshotWidgetReflectorNode> Create();
|
|
|
|
/**
|
|
* Create a snapshot node instance node from the given widget geometry, caching out any data that may be required for future visualization in the widget reflector
|
|
*/
|
|
static TSharedRef<FSnapshotWidgetReflectorNode> Create(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
// FWidgetReflectorNodeBase interface
|
|
virtual EWidgetReflectorNodeType GetNodeType() const override;
|
|
virtual TSharedPtr<SWidget> GetLiveWidget() const override;
|
|
virtual FText GetWidgetType() const override;
|
|
virtual FText GetWidgetTypeAndShortName() const override;
|
|
virtual FText GetWidgetVisibilityText() const override;
|
|
virtual FText GetWidgetClippingText() const override;
|
|
virtual bool GetWidgetVisible() const override;
|
|
virtual bool GetWidgetFocusable() const override;
|
|
virtual bool GetWidgetNeedsTick() const override;
|
|
virtual bool GetWidgetIsVolatile() const override;
|
|
virtual bool GetWidgetIsVolatileIndirectly() const override;
|
|
virtual bool GetWidgetHasActiveTimers() const override;
|
|
virtual FText GetWidgetReadableLocation() const override;
|
|
virtual FString GetWidgetFile() const override;
|
|
virtual int32 GetWidgetLineNumber() const override;
|
|
virtual FAssetData GetWidgetAssetData() const override;
|
|
virtual FVector2D GetWidgetDesiredSize() const override;
|
|
virtual FSlateColor GetWidgetForegroundColor() const override;
|
|
virtual FString GetWidgetAddress() const override;
|
|
virtual bool GetWidgetEnabled() const override;
|
|
virtual bool IsWidgetLive() const override { return false; }
|
|
|
|
/** Save this node data as a JSON object */
|
|
static TSharedRef<FJsonValue> ToJson(const TSharedRef<FSnapshotWidgetReflectorNode>& RootSnapshotNode);
|
|
|
|
/** Populate this node data from a JSON object */
|
|
static TSharedRef<FSnapshotWidgetReflectorNode> FromJson(const TSharedRef<FJsonValue>& RootJsonValue);
|
|
|
|
private:
|
|
/**
|
|
* Default constructor
|
|
*/
|
|
FSnapshotWidgetReflectorNode();
|
|
|
|
/**
|
|
* Construct this node from the given widget geometry, caching out any data that may be required for future visualization in the widget reflector
|
|
*/
|
|
explicit FSnapshotWidgetReflectorNode(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
private:
|
|
/** The type string of the widget at the point it was passed to Initialize */
|
|
FText CachedWidgetType;
|
|
|
|
/** */
|
|
FText CachedWidgetTypeAndShortName;
|
|
|
|
/** The visibility string of the widget at the point it was passed to Initialize */
|
|
FText CachedWidgetVisibilityText;
|
|
|
|
/** Is the widget visible? */
|
|
bool bCachedWidgetVisible;
|
|
|
|
/** The focusability of the widget at the point it was passed to Initialize */
|
|
bool bCachedWidgetFocusable;
|
|
|
|
bool CachedWidgetNeedsTick;
|
|
bool CachedWidgetIsVolatile;
|
|
bool CachedWidgetIsVolatileIndirectly;
|
|
bool CachedWidgetHasActiveTimers;
|
|
|
|
/** The clipping string of the widget at the point it was passed to Initialize */
|
|
FText CachedWidgetClippingText;
|
|
|
|
/** The human readable location (source file for C++ widgets, asset name for UMG widgets) of the widget at the point it was passed to Initialize */
|
|
FText CachedWidgetReadableLocation;
|
|
|
|
/** The name of the file that the widget was created from at the point it was passed to Initialize (for C++ widgets) */
|
|
FString CachedWidgetFile;
|
|
|
|
/** The line number of the file that the widget was created from at the point it was passed to Initialize (for C++ widgets) */
|
|
int32 CachedWidgetLineNumber;
|
|
|
|
/** The name of the asset that the widget was created from at the point it was passed to Initialize (for UMG widgets) */
|
|
FAssetData CachedWidgetAssetData;
|
|
|
|
/** The desired size of the widget at the point it was passed to Initialize */
|
|
FVector2D CachedWidgetDesiredSize;
|
|
|
|
/** The foreground color of the widget at the point it was passed to Initialize */
|
|
FSlateColor CachedWidgetForegroundColor;
|
|
|
|
/** The in-memory address of the widget at the point it was passed to Initialize */
|
|
FString CachedWidgetAddress;
|
|
|
|
/** The enabled state of the widget at the point it was passed to Initialize */
|
|
bool CachedWidgetEnabled;
|
|
};
|
|
|
|
|
|
class FWidgetReflectorNodeUtils
|
|
{
|
|
public:
|
|
/**
|
|
* Create a single node referencing a live widget.
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Optional widget and associated geometry which this node should represent
|
|
*/
|
|
static TSharedRef<FLiveWidgetReflectorNode> NewLiveNode(const FArrangedWidget& InWidgetGeometry = FArrangedWidget(SNullWidget::NullWidget, FGeometry()));
|
|
|
|
/**
|
|
* Create nodes for the supplied widget and all their children such that they reference a live widget
|
|
* Note that we include both visible and invisible children!
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Widget and geometry whose children to capture in the snapshot.
|
|
*/
|
|
static TSharedRef<FLiveWidgetReflectorNode> NewLiveNodeTreeFrom(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
/**
|
|
* Create a single node referencing a snapshot of its current state.
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Optional widget and associated geometry which this node should represent
|
|
*/
|
|
static TSharedRef<FSnapshotWidgetReflectorNode> NewSnapshotNode(const FArrangedWidget& InWidgetGeometry = FArrangedWidget(SNullWidget::NullWidget, FGeometry()));
|
|
|
|
/**
|
|
* Create nodes for the supplied widget and all their children such that they reference a snapshot of their current state
|
|
* Note that we include both visible and invisible children!
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Widget and geometry whose children to capture in the snapshot.
|
|
*/
|
|
static TSharedRef<FSnapshotWidgetReflectorNode> NewSnapshotNodeTreeFrom(const FArrangedWidget& InWidgetGeometry);
|
|
|
|
private:
|
|
/**
|
|
* Create a single node.
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Optional widget and associated geometry which this node should represent
|
|
*/
|
|
static TSharedRef<FWidgetReflectorNodeBase> NewNode(const EWidgetReflectorNodeType InNodeType, const FArrangedWidget& InWidgetGeometry = FArrangedWidget(SNullWidget::NullWidget, FGeometry()));
|
|
|
|
/**
|
|
* Create nodes for the supplied widget and all their children
|
|
* Note that we include both visible and invisible children!
|
|
*
|
|
* @param InNodeClass The type of widget reflector node to create
|
|
* @param InWidgetGeometry Widget and geometry whose children to capture in the snapshot.
|
|
*/
|
|
static TSharedRef<FWidgetReflectorNodeBase> NewNodeTreeFrom(const EWidgetReflectorNodeType InNodeType, const FArrangedWidget& InWidgetGeometry);
|
|
|
|
public:
|
|
/**
|
|
* Locate all the widgets from a widget path in a list of nodes and their children.
|
|
* @note This only really works for live nodes, as the snapshot nodes may no longer exist, or not even be local to this machine
|
|
*
|
|
* @param CandidateNodes A list of FReflectorNodes that represent widgets.
|
|
* @param WidgetPathToFind We want to find all reflector nodes corresponding to widgets in this path
|
|
* @param SearchResult An array that gets results put in it
|
|
* @param NodeIndexToFind Index of the widget in the path that we are currently looking for; we are done when we've found all of them
|
|
*/
|
|
static void FindLiveWidgetPath(const TArray<TSharedRef<FWidgetReflectorNodeBase>>& CandidateNodes, const FWidgetPath& WidgetPathToFind, TArray<TSharedRef<FWidgetReflectorNodeBase>>& SearchResult, int32 NodeIndexToFind = 0);
|
|
|
|
public:
|
|
/**
|
|
* @return The type string for the given widget
|
|
*/
|
|
static FText GetWidgetType(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The type string combined with a short name (if any) for the given widget
|
|
*/
|
|
static FText GetWidgetTypeAndShortName(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The current visibility string for the given widget
|
|
*/
|
|
static FText GetWidgetVisibilityText(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/** Is the widget visible? */
|
|
static bool GetWidgetVisibility(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The current clipping string for the given widget
|
|
*/
|
|
static FText GetWidgetClippingText(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The current focusability for the given widget
|
|
*/
|
|
static bool GetWidgetFocusable(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
static bool GetWidgetNeedsTick(const TSharedPtr<SWidget>& InWidget);
|
|
static bool GetWidgetIsVolatile(const TSharedPtr<SWidget>& InWidget);
|
|
static bool GetWidgetIsVolatileIndirectly(const TSharedPtr<SWidget>& InWidget);
|
|
static bool GetWidgetHasActiveTimers(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* The human readable location for widgets that are defined in C++ is the file and line number
|
|
* The human readable location for widgets that are defined in UMG is the asset name
|
|
* @return The fully human readable location for the given widget
|
|
*/
|
|
static FText GetWidgetReadableLocation(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The name of the file that this widget was created from (for C++ widgets)
|
|
*/
|
|
static FString GetWidgetFile(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The line number of the file that this widget was created from (for C++ widgets)
|
|
*/
|
|
static int32 GetWidgetLineNumber(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The name of the asset that this widget was created from (for UMG widgets)
|
|
*/
|
|
static FAssetData GetWidgetAssetData(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The current desired size of the given widget
|
|
*/
|
|
static FVector2D GetWidgetDesiredSize(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The in-memory address of the widget, converted to a string
|
|
*/
|
|
static FString GetWidgetAddress(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return The current foreground color of the given widget
|
|
*/
|
|
static FSlateColor GetWidgetForegroundColor(const TSharedPtr<SWidget>& InWidget);
|
|
|
|
/**
|
|
* @return True if the given widget is currently enabled, false otherwise
|
|
*/
|
|
static bool GetWidgetEnabled(const TSharedPtr<SWidget>& InWidget);
|
|
};
|