PoseWatch.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 "UObject/Object.h"
#include "BoneIndices.h"
#include "PoseWatch.generated.h"
 
struct FCompactHeapPose;
class UAnimBlueprint;
class UBlendProfile;
struct FSlateIcon;
 
namespace PoseWatchUtil
{
    TSet<UPoseWatch*> GetChildrenPoseWatchOf(const UPoseWatchFolder* Folder, const UAnimBlueprint* AnimBlueprint);
 
    TSet<UPoseWatchFolder*> GetChildrenPoseWatchFoldersOf(const UPoseWatchFolder* Folder, const UAnimBlueprint* AnimBlueprint);
 
    FColor ChoosePoseWatchColor();
 
    template <typename TParent, typename TItem> FText FindUniqueNameInParent(TParent* InParent, const TItem* InItem);
}
 
UCLASS(MinimalAPI)
class UPoseWatchFolder
    : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
#if WITH_EDITOR
    ENGINE_API const FText GetPath() const;
 
    ENGINE_API FText GetDefaultLabel() const;
 
    ENGINE_API FText GetLabel() const;
 
    ENGINE_API bool GetIsVisible() const;
 
    ENGINE_API UPoseWatchFolder* GetParent() const;
    
    ENGINE_API bool SetParent(UPoseWatchFolder* Parent, bool bForce = false);
 
    ENGINE_API void MoveTo(UPoseWatchFolder* InFolder);
 
    ENGINE_API bool SetLabel(const FText& InLabel);
 
    ENGINE_API void SetIsVisible(bool bInIsVisible, bool bUpdateChildren=true);
 
    ENGINE_API void OnRemoved();
 
    ENGINE_API bool IsIn(const UPoseWatchFolder* InFolder) const;
 
    ENGINE_API bool IsDescendantOf(const UPoseWatchFolder* InFolder) const;
 
    ENGINE_API bool IsAssignedFolder() const;
 
    ENGINE_API bool ValidateLabelRename(const FText& InLabel, FText& OutErrorMessage);
 
    ENGINE_API bool IsLabelUniqueInParent(const FText& InLabel, UPoseWatchFolder* InFolder) const;
 
    ENGINE_API bool HasChildren() const;
 
    ENGINE_API void SetUniqueDefaultLabel();
 
    ENGINE_API void UpdateVisibility();
 
    ENGINE_API UAnimBlueprint* GetAnimBlueprint() const;
 
    ENGINE_API void SetIsExpanded(bool bInIsExpanded);
 
    ENGINE_API bool GetIsExpanded() const;
 
private:
    FText FindUniqueNameInParent(UPoseWatchFolder* InParent) const;
 
    bool HasPoseWatchChildren() const;
 
    bool HasPoseWatchDescendents() const;
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
protected:
    UPROPERTY()
    FText Label;
 
    UPROPERTY()
    TWeakObjectPtr<UPoseWatchFolder> Parent;
 
    UPROPERTY()
    bool bIsVisible = false;
 
    UPROPERTY(Transient)
    bool bIsExpanded = true;
#endif // WITH_EDITORONLY_DATA
};
 
UCLASS(MinimalAPI)
class UPoseWatchElement
    : public UObject
{
    GENERATED_BODY()
 
public:
#if WITH_EDITOR
 
    virtual ~UPoseWatchElement() = default;
 
    ENGINE_API FText GetDefaultLabel() const;
 
    ENGINE_API FText GetLabel() const;
 
    ENGINE_API bool GetIsVisible() const;
 
    ENGINE_API virtual bool GetIsEnabled() const;
 
    ENGINE_API UPoseWatch* GetParent() const;
 
    ENGINE_API void SetParent(UPoseWatch* InParent);
 
    ENGINE_API bool SetLabel(const FText& InLabel);
 
    ENGINE_API virtual void SetIsVisible(bool bInIsVisible);
 
    ENGINE_API bool ValidateLabelRename(const FText& InLabel, FText& OutErrorMessage);
 
    ENGINE_API bool IsLabelUniqueInParent(const FText& InLabel, UPoseWatch* InParent) const;
 
    ENGINE_API void SetUniqueDefaultLabel();
 
    ENGINE_API void SetUniqueLabel(const FText& InLabel);
 
    ENGINE_API FColor GetColor() const;
 
    ENGINE_API virtual void SetColor(const FColor& InColor);
 
    ENGINE_API bool HasColor() const;
 
    ENGINE_API void SetHasColor(const bool bInHasColor);
 
    ENGINE_API FName GetIconName() const;
 
    ENGINE_API void SetIconName(const FName InIconName);
 
    ENGINE_API void ToggleIsVisible();
 
private:
    ENGINE_API FText FindUniqueNameInParent(class UPoseWatch* InParent) const;
 
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
protected:
 
    // If true will draw the node to the view port.
    UPROPERTY()
    bool bIsVisible = true;
 
    UPROPERTY()
    bool bHasColor = true;
 
    UPROPERTY()
    FColor Color;
 
    UPROPERTY()
    FText Label;
 
    UPROPERTY()
    FName IconName;
 
    UPROPERTY()
    TWeakObjectPtr<UPoseWatch> Parent;
 
#endif // WITH_EDITORONLY_DATA
};
 
UCLASS(MinimalAPI)
class UPoseWatchPoseElement : public UPoseWatchElement
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API UPoseWatchPoseElement(const class FObjectInitializer& PCIP);
 
#if WITH_EDITOR
 
    ENGINE_API virtual bool GetIsEnabled() const;
 
    static ENGINE_API FSlateIcon StaticGetIcon();
 
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, editfixedsize, Category = Default, meta = (UseAsBlendMask = true))
    TObjectPtr<UBlendProfile> ViewportMask;
 
    UPROPERTY(EditAnywhere, Category = Default, meta = (EditCondition = "ViewportMask != nullptr"))
    bool bInvertViewportMask;
 
    UPROPERTY(EditAnywhere, Category = Default, meta = (ClampMin = 0.f, ClampMax = 1.f, EditCondition = "ViewportMask != nullptr"))
    float BlendScaleThreshold;
 
    UPROPERTY(EditAnywhere, Category = Default)
    FVector3d ViewportOffset;
#endif // WITH_EDITORONLY_DATA
};
 
UCLASS(MinimalAPI)
class UPoseWatch
    : public UObject
{
    GENERATED_UCLASS_BODY()
 
public:
#if WITH_EDITOR
    ENGINE_API const FText GetPath() const;
 
    ENGINE_API FText GetDefaultLabel() const;
 
    ENGINE_API FText GetLabel() const;
 
    ENGINE_API bool GetIsVisible() const;
 
    ENGINE_API bool GetIsEnabled() const;
 
    ENGINE_API bool GetIsNodeEnabled() const;
 
    UE_DEPRECATED(5.1, "Node watches no longer have colors, use the color of its elements instead.")
    ENGINE_API FColor GetColor() const;
 
    ENGINE_API void SetIsExpanded(bool bInIsExpanded);
 
    ENGINE_API bool GetIsExpanded() const;
 
    ENGINE_API bool GetShouldDeleteOnDeselect() const;
 
    ENGINE_API UPoseWatchFolder* GetParent() const;
 
    ENGINE_API bool SetParent(UPoseWatchFolder* InParent, bool bForce=false);
 
    ENGINE_API void SetIsNodeEnabled(const bool bInIsEnabled);
 
    ENGINE_API void MoveTo(UPoseWatchFolder* InFolder);
 
    ENGINE_API bool SetLabel(const FText& InLabel);
 
    ENGINE_API void SetIsVisible(bool bInIsVisible);
 
    UE_DEPRECATED(5.1, "Node watches no longer have colors, use the color of its elements instead.")
    ENGINE_API void SetColor(const FColor& InColor);
 
    ENGINE_API void SetShouldDeleteOnDeselect(const bool bInDeleteOnDeselection);
 
    ENGINE_API void OnRemoved();
 
    ENGINE_API void ToggleIsVisible();
 
    ENGINE_API bool IsIn(const UPoseWatchFolder* InFolder) const;
 
    ENGINE_API bool IsAssignedFolder() const;
 
    ENGINE_API bool ValidateLabelRename(const FText& InLabel, FText& OutErrorMessage);
 
    ENGINE_API bool IsLabelUniqueInParent(const FText& InLabel, UPoseWatchFolder* InFolder) const;
 
    ENGINE_API void SetUniqueDefaultLabel();
 
    ENGINE_API void UpdateVisibility();
 
    ENGINE_API UAnimBlueprint* GetAnimBlueprint() const;
 
    ENGINE_API TObjectPtr<UPoseWatchElement> AddElement(const FText InLabel, const FName IconName);
 
    template< class TElementType > TObjectPtr<TElementType> AddElement(const FText InLabel, const FName IconName);
    
    TArray<TObjectPtr<UPoseWatchElement>>& GetElements() { return Elements; }
 
    ENGINE_API TObjectPtr<UPoseWatchElement> FindElement(const FText InLabel);
 
    ENGINE_API TObjectPtr<UPoseWatchElement> FindOrAddElement(const FText InLabel, const FName InIconName);
 
    bool Contains(const TObjectPtr<UPoseWatchElement> InElement) { return Elements.Contains(InElement); }
    bool Contains(const UPoseWatchElement* const InElement) { return Elements.ContainsByPredicate([InElement](const TObjectPtr<UPoseWatchElement>& ContainedElement) { return InElement == ContainedElement.Get(); }); }
 
    template< class TElementType > TObjectPtr<TElementType> GetFirstElementOfType()
    {
        for (UPoseWatchElement* Element : Elements)
        {
            if (TElementType* FoundElement = Cast<TElementType>(Element))
            {
                return FoundElement;
            }
        }
        return nullptr;
    }
 
    
private:
    ENGINE_API FText FindUniqueNameInParent(UPoseWatchFolder* InParent) const;
 
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
public:
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
 
    UPROPERTY()
    TWeakObjectPtr<class UEdGraphNode> Node;
 
    UPROPERTY()
    TObjectPtr<UBlendProfile> ViewportMask_DEPRECATED;
    UPROPERTY()
    bool bInvertViewportMask_DEPRECATED;
    UPROPERTY()
    float BlendScaleThreshold_DEPRECATED;
    UPROPERTY()
    FVector3d ViewportOffset_DEPRECATED;
 
protected:
    UPROPERTY()
    TArray<TObjectPtr<UPoseWatchElement>> Elements;
 
    UPROPERTY()
    bool bDeleteOnDeselection = false;
 
    // If true will draw the pose to the viewport
    UPROPERTY()
    bool bIsVisible = true;
 
    // If true, the node is able to be drawn to the view port.
    UPROPERTY(Transient)
    bool bIsNodeEnabled = false;
 
    UPROPERTY()
    bool bIsExpanded = true;
 
    UPROPERTY()
    FColor Color_DEPRECATED;
 
    UPROPERTY()
    FText Label;
 
    UPROPERTY()
    FName IconName_DEPRECATED;
 
    UPROPERTY()
    TWeakObjectPtr<UPoseWatchFolder> Parent;
#endif // WITH_EDITORONLY_DATA
};
 
 
#if WITH_EDITOR
 
template< class TElementType > TObjectPtr<TElementType> UPoseWatch::AddElement(const FText InLabel, const FName InIconName)
{
    TObjectPtr<TElementType> PoseWatchElement(NewObject<TElementType>(this));
    PoseWatchElement->SetParent(this);
    PoseWatchElement->SetUniqueLabel(InLabel);
    PoseWatchElement->SetIconName(InIconName);
    PoseWatchElement->SetColor(FColor::MakeRandomColor());
    Elements.Add(PoseWatchElement);
 
    return PoseWatchElement;
}
 
#endif // WITH_EDITOR