TransformConstraintUtil.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Constraint.h"
 
#include "Containers/Array.h"
#include "Containers/Map.h"
 
#include "Delegates/IDelegateInstance.h"
#include "UObject/ObjectKey.h"
 
#define UE_API CONSTRAINTS_API
 
class UWorld;
class UTickableConstraint;
class UTransformableHandle;
class UTickableTransformConstraint;
class UTransformableComponentHandle;
 
namespace UE::TransformConstraintUtil
{
 
struct FConstraintsInteractionCache
{
public:
    UE_API void Reset();
 
    UE_API const TArray< TWeakObjectPtr<UTickableConstraint> >& Get(const UObject* InObject, const FName& InAttachmentName);
    UE_API bool HasAnyActiveConstraint(const UObject* InObject, const FName& InAttachmentName);
    UE_API TOptional<FTransform> GetParentTransform(const UObject* InObject, const FName& InAttachmentName);
 
    UE_API const TArray< TWeakObjectPtr<UTickableConstraint> >& Get(const uint32 InHandleHash, UWorld* InWorld);
    UE_API bool HasAnyActiveConstraint(const uint32 InHandleHash, UWorld* InWorld);
    UE_API TOptional<FTransform> GetParentTransform(const uint32 InHandleHash, UWorld* InWorld);
 
    UE_API const TArray< TWeakObjectPtr<UTickableConstraint> >& Get(UObject* InTarget, UWorld* InWorld = nullptr);
    UE_API bool HasAnyActiveConstraint(UObject* InTarget, UWorld* InWorld = nullptr);
 
    UE_API bool HasAnyDependency(UObject* InChild, UObject* InParent, UWorld* InWorld);
    
    UE_API void RegisterNotifications();
    UE_API void UnregisterNotifications();
 
private:
 
    bool HasAnyDependencyInternal(UObject* InChild, UObject* InParent, UWorld* InWorld, TSet< UObject* >& Visited);
    
    TMap<uint32, TArray< TWeakObjectPtr<UTickableConstraint> >> PerHandleConstraints;
    TMap<TObjectKey<UObject>, TArray< TWeakObjectPtr<UTickableConstraint> >> PerTargetConstraints;
    FDelegateHandle ConstraintsNotificationHandle;
};
 
}
 
 
namespace UE::TransformConstraintUtil
{
 
    CONSTRAINTS_API void GetParentConstraints(
        UWorld* World,
        const AActor* InChild,
        TArray< TWeakObjectPtr<UTickableConstraint> >& OutConstraints);
 
    CONSTRAINTS_API UTransformableComponentHandle* CreateHandleForSceneComponent(
        USceneComponent* InSceneComponent,
        const FName& InSocketName);
 
    CONSTRAINTS_API UTickableTransformConstraint* CreateFromType(
        UWorld* InWorld,
        const ETransformConstraintType InType,
        const bool bUseDefault = false);
 
    CONSTRAINTS_API UTickableTransformConstraint* CreateAndAddFromObjects(
        UWorld* InWorld,
        UObject* InParent, const FName& InParentSocketName,
        UObject* InChild, const FName& InChildSocketName,
        const ETransformConstraintType InType,
        const bool bMaintainOffset = true,
        const bool bUseDefault = false,
        const TFunction<void()>& InValidDependencyFunction = nullptr);
 
    CONSTRAINTS_API bool AddConstraint(
        UWorld* InWorld,
        UTransformableHandle* InParentHandle,
        UTransformableHandle* InChildHandle,
        UTickableTransformConstraint* Constraint,
        const bool bMaintainOffset = true,
        const bool bUseDefault = false);
 
    CONSTRAINTS_API FTransform ComputeRelativeTransform(
        const FTransform& InChildLocal,
        const FTransform& InChildWorld,
        const FTransform& InSpaceWorld,
        const UTickableTransformConstraint* InConstraint);
 
    CONSTRAINTS_API TOptional<FTransform> GetRelativeTransform(UWorld* InWorld, const uint32 InHandleHash);
    CONSTRAINTS_API TOptional<FTransform> GetConstraintsRelativeTransform(
        const TArray< TWeakObjectPtr<UTickableConstraint> >& InConstraints,
        const FTransform& InChildLocal, const FTransform& InChildWorld);
 
    CONSTRAINTS_API int32 GetLastActiveConstraintIndex(const TArray< TWeakObjectPtr<UTickableConstraint> >& InConstraints);
 
    CONSTRAINTS_API void GetChildrenConstraints(
        UWorld* World,
        const UTickableTransformConstraint* InConstraint,
        TArray< TWeakObjectPtr<UTickableConstraint> >& OutConstraints,
        const bool bIncludeTarget = false);
    
    CONSTRAINTS_API void UpdateTransformBasedOnConstraint(FTransform& InOutCurrentTransform, const USceneComponent* InSceneComponent);
 
    CONSTRAINTS_API UTickableTransformConstraint* GetConfig(const UClass* InConstraintClass);
}
 
#undef UE_API