Files
UnrealEngineUWP/Engine/Source/Editor/AnimGraph/Public/AnimGraphNode_CustomProperty.h
Thomas Sarkanen 16eee0289d Anim node data/compiler refactor
Per-node constant data is now held on a generated struct as part of sparse class data.
Per-node mutable data (i.e. pin links/property access mappings) is now held on a generated 'mutable data' struct that is compiled as part of the generated class.

The anim BP compiler is now extended more conventionally using UAnimBlueprintExtension, derived from UBlueprintExtension. This directly replaces the older 'compiler handler' pattern that was added in an emergency fashion for 4.26. Anim graph nodes now request their required extensions and these are held on the UAnimBlueprint in the UBlueprint::Extensions array. The Extensions array is potentially refreshed with any node addition or removal. The Extensions array is force-refreshed each time an anim BP is compiled for the first time to deal with newly added or removed requirements.

Const-corrected a bunch of UAnimInstance/FAnimInstanceProxy APIs that rely on (now truly) const data.
Added a split state/constant version of FInputScaleBiasClamp to allow some of its data to be split into constants.
Tweaked alignment/ordering of FPoseLinkBase to save a few bytes per pose link.
Deprecated FAnimNode_Base::OverrideAsset in favor of a more UAnimGraphNode_Base-based approach. Individual nodes can still have runtime overrides via specific accessors. The new approach will also give us the oppurtunity to override multiple assets per node if required in the future.

Moved property access into Engine module & removed event support from it - this was never used.
Reworked property access compilation API a little - construction/lifetime was a bit confusing previously.

Optimized path used to create UK2Node_StructMemberSet nodes in per-node custom events. When using mutable data, the structure used is large and very sparsely connected (i.e. only a few properties are written) so we only create pins that are actually going to be used, rather than creating all of them and conly connecting a few.

Patched the following nodes to use the new data approach:

- Asset players (sequences, blendspaces, aim offsets)
- Blend lists
- Ref poses
- Roots

#rb Jurre.deBaare, Martin.Wilson, Keith.Yerex

[CL 16090510 by Thomas Sarkanen in ue5-main branch]
2021-04-22 04:57:09 -04:00

93 lines
4.2 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Guid.h"
#include "AnimGraphNode_Base.h"
#include "Animation/AnimNode_CustomProperty.h"
#include "IClassVariableCreator.h"
#include "AnimGraphNode_CustomProperty.generated.h"
class FCompilerResultsLog;
class IDetailLayoutBuilder;
class IPropertyHandle;
UCLASS(Abstract)
class ANIMGRAPH_API UAnimGraphNode_CustomProperty : public UAnimGraphNode_Base, public IClassVariableCreator
{
GENERATED_BODY()
public:
// IClassVariableCreator interface
virtual void CreateClassVariablesFromBlueprint(IAnimBlueprintVariableCreationContext& InCreationContext) override;
//~ Begin UEdGraphNode Interface.
virtual void ValidateAnimNodeDuringCompilation(USkeleton* ForSkeleton, FCompilerResultsLog& MessageLog) override;
virtual void ReallocatePinsDuringReconstruction(TArray<UEdGraphPin*>& OldPins) override;
virtual UObject* GetJumpTargetForDoubleClick() const override;
virtual bool HasExternalDependencies(TArray<class UStruct*>* OptionalOutput /*= NULL*/) const override;
//~ End UEdGraphNode Interface.
// UAnimGraphNode_Base interface
virtual void CustomizeDetails(IDetailLayoutBuilder& DetailBuilder) override;
virtual void OnProcessDuringCompilation(IAnimBlueprintCompilationContext& InCompilationContext, IAnimBlueprintGeneratedClassCompiledData& OutCompiledData) override;
// Gets the property on InOwnerInstanceClass that corresponds to InInputPin
void GetInstancePinProperty(const IAnimBlueprintCompilationContext& InCompilationContext, UEdGraphPin* InInputPin, FProperty*& OutProperty);
// Gets the unique name for the property linked to a given pin
FString GetPinTargetVariableName(const UEdGraphPin* InPin) const;
// Gets Target Class this properties to link
UClass* GetTargetClass() const;
// Add Source and Target Properties - Check FAnimNode_CustomProperty
void AddSourceTargetProperties(const FName& InSourcePropertyName, const FName& InTargetPropertyName);
// Helper used to get the skeleton class we are targeting
virtual UClass* GetTargetSkeletonClass() const;
// ----- UI CALLBACKS ----- //
// User changed the instance class etc.
void OnStructuralPropertyChanged(IDetailLayoutBuilder* DetailBuilder);
// If given property exposed on this node
virtual ECheckBoxState IsPropertyExposed(FName PropertyName) const;
// User chose to expose, or unexpose a property
virtual void OnPropertyExposeCheckboxChanged(ECheckBoxState NewState, FName PropertyName);
// If all possible properties are exposed on this node
virtual ECheckBoxState AreAllPropertiesExposed() const;
// User chose to expose, or unexpose all properties
virtual void OnPropertyExposeAllCheckboxChanged(ECheckBoxState NewState);
// User changed the instance class
void OnInstanceClassChanged(IDetailLayoutBuilder* DetailBuilder);
protected:
/** List of property names we know to exist on the target class, so we can detect when
* Properties are added or removed on reconstruction
*/
UPROPERTY()
TArray<FName> KnownExposableProperties;
/** Names of properties the user has chosen to expose */
UPROPERTY()
TArray<FName> ExposedPropertyNames;
// Searches the instance class for properties that we can expose (public and BP visible)
virtual void GetExposableProperties(TArray<FProperty*>& OutExposableProperties) const;
// Gets a property's type as FText (for UI)
FText GetPropertyTypeText(FProperty* Property);
// Given a new class, rebuild the known property list (for tracking class changes and moving pins)
virtual void RebuildExposedProperties();
// internal node accessor
virtual FAnimNode_CustomProperty* GetCustomPropertyNode() PURE_VIRTUAL(UAnimGraphNode_CustomProperty::GetCustomPropertyNode, return nullptr;);
virtual const FAnimNode_CustomProperty* GetCustomPropertyNode() const PURE_VIRTUAL(UAnimGraphNode_CustomProperty::GetCustomPropertyNode, return nullptr;);
// Check whether the specified property is structural (i.e. should we rebuild the UI if it changes)
virtual bool IsStructuralProperty(FProperty* InProperty) const { return false; }
// Whether this node needs a valid target class up-front
virtual bool NeedsToSpecifyValidTargetClass() const { return true; }
};