PointWeightMap.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include <type_traits>
 
#include "UObject/ObjectMacros.h"
#include "PointWeightMap.generated.h"
 
UENUM()
enum class EWeightMapTargetCommon : uint8
{
    None = 0,            // None, should always be zero
    MaxDistance,         // The distance that each vertex can move away from its reference (skinned) position
    BackstopDistance,    // Distance along the plane of the surface that the particles can travel (separation constraint)
    BackstopRadius,      // Radius of movement to allow for backstop movement
    AnimDriveStiffness,  // Strength of anim drive per-particle (spring driving particle back to skinned location
    AnimDriveDamping_DEPRECATED UMETA(Hidden),  // Chaos onlyweightmap, deprecated from the common declaration
    FirstUserTarget,
    // Users can add additional targets between this range.
    LastUserTarget = 200,
    // Add additional common targets after here.
    TetherEndsMask
};
 
USTRUCT()
struct FPointWeightMap
{
    GENERATED_BODY();
 
    FPointWeightMap()
#if WITH_EDITORONLY_DATA
        : Name(NAME_None)
        , CurrentTarget((uint8)EWeightMapTargetCommon::None)
        , bEnabled(false)
#endif
    {}
 
    explicit FPointWeightMap(int32 NumPoints, float Value = 0.f)
#if WITH_EDITORONLY_DATA
        : Name(NAME_None)
        , CurrentTarget((uint8)EWeightMapTargetCommon::None)
        , bEnabled(false)
#endif
    {
        Values.Init(Value, NumPoints);
    }
 
    explicit FPointWeightMap(const TConstArrayView<float>& InValues)
        : Values(InValues)
#if WITH_EDITORONLY_DATA
        , Name(NAME_None)
        , CurrentTarget((uint8)EWeightMapTargetCommon::None)
        , bEnabled(false)
#endif
    {}
 
    FPointWeightMap(const TConstArrayView<float>& InValues, float Offset, float Scale)
#if WITH_EDITORONLY_DATA
        : Name(NAME_None)
        , CurrentTarget((uint8)EWeightMapTargetCommon::None)
        , bEnabled(false)
#endif
    {
        const int32 NumPoints = InValues.Num();
        Values.SetNumUninitialized(NumPoints);
        for (int32 Index = 0; Index < NumPoints; ++Index)
        {
            Values[Index] = Offset + Scale * InValues[Index];
        }
    }
 
    ~FPointWeightMap()
    {}
 
    void Initialize(const int32 NumPoints)
    {
        Values.Init(0.f, NumPoints);
#if WITH_EDITORONLY_DATA
        CurrentTarget = (uint8)EWeightMapTargetCommon::None;
        bEnabled = false;
#endif
    }
 
    template <
        typename T
        UE_REQUIRES(std::is_enum_v<T> || std::is_arithmetic_v<T>)
    >
    void Initialize(const FPointWeightMap& Source, T Target)
    {
        Values = Source.Values;
#if WITH_EDITORONLY_DATA
        CurrentTarget = (uint8)Target;
        bEnabled = true;
#endif
    }
 
    void Empty()
    { Values.Empty(); }
 
    int32 Num() const
    { return Values.Num(); }
 
    const float& operator[](int32 Index) const
    { return Values[Index]; }
 
    float& operator[](int32 Index)
    { return Values[Index]; }
 
    float GetValue(int32 Index) const
    { return Values.IsValidIndex(Index) ? Values[Index] : 0.f; }
 
    void SetValue(int32 Index, float Value)
    { if (Values.IsValidIndex(Index)) Values[Index] = Value; }
 
    bool IsBelowThreshold(const int32 Index, const float Threshold=0.1f) const
    { return Values.IsValidIndex(Index) && Values[Index] <= Threshold; }
 
    bool AreAnyBelowThreshold(const int32 Index0, const int32 Index1, const int32 Index2, const float Threshold=0.1f) const
    { return IsBelowThreshold(Index0, Threshold) || IsBelowThreshold(Index1, Threshold) || IsBelowThreshold(Index2, Threshold); }
 
    bool AreAllBelowThreshold(const int32 Index0, const int32 Index1, const int32 Index2, const float Threshold=0.1f) const
    { return IsBelowThreshold(Index0, Threshold) && IsBelowThreshold(Index1, Threshold) && IsBelowThreshold(Index2, Threshold); }
 
    bool IsZeroed() const
    { return !Values.FindByPredicate([](const float& Value) { return Value != 0.f; }); }
 
    void CalcRanges(float& MinValue, float& MaxValue)
    { MinValue = FMath::Min(Values); MaxValue = FMath::Max(Values); }
 
    UPROPERTY()
    TArray<float> Values;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FName Name;
 
    UPROPERTY()
    uint8 CurrentTarget;
 
    UPROPERTY()
    bool bEnabled;
#endif
};