FPBDWeightMap | Unreal Engine 5.7 Documentation

Weight map class for managing real time update to the weight map and low/high value ranges


Name	FPBDWeightMap
Type	class
Header File	/Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDWeightMap.h
Include Path	#include "Chaos/PBDWeightMap.h"

Syntax

class FPBDWeightMap

Name	Remarks	Include Path
FPBDWeightMap ( const FSolverVec2& InWeightedValue, const TConstArrayView< FRealSingle >& Multipliers, const TConstArrayView< TVector< int32, Valence > >& Constraints, int32 ParticleOffset, int32 ParticleCount, int32 TableSize, typename TEnableIf< Valence >, ::Type* )	Weightmap constraint constructor.	Chaos/PBDWeightMap.h
FPBDWeightMap ( const FSolverVec2& InWeightedValue, const TConstArrayView< FRealSingle >& Multipliers, int32 ParticleCount, int32 TableSize )	Weightmap particle constructor.	Chaos/PBDWeightMap.h
FPBDWeightMap ( FPBDWeightMap&& )		Chaos/PBDWeightMap.h
FPBDWeightMap ( const FPBDWeightMap& )		Chaos/PBDWeightMap.h

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FPBDWeightMap()		Chaos/PBDWeightMap.h

Name	Remarks	Include Path
void ApplyValues ( bool* bOutUpdated )	Update the weight map table with the current simulation parameters.	Chaos/PBDWeightMap.h
FSolverReal GetHigh()	Return the exponential value at the High weight.	Chaos/PBDWeightMap.h
TConstArrayView< uint8 > GetIndices()	Return the particles/constraints indices to the stiffness table as a read only array.	Chaos/PBDWeightMap.h
FSolverReal GetLow()	Return the exponential value at the Low weight.	Chaos/PBDWeightMap.h
TConstArrayView< FSolverReal > GetTable()	Return the table of stiffnesses as a read only array.	Chaos/PBDWeightMap.h
FSolverReal GetValue ( int32 Index ) const		Chaos/PBDWeightMap.h
const FSolverVec2 & GetWeightedValue ()	Return the low and high values set for this weight map.	Chaos/PBDWeightMap.h
bool HasWeightMap()	Return whether this object contains weight map values.	Chaos/PBDWeightMap.h
int32 Num()	Return the number of values stored in the weight map.	Chaos/PBDWeightMap.h
void ReorderIndices ( const TArray< int32 >& OrigToReorderedIndices )	Reorder Indices based on Constraint reordering.	Chaos/PBDWeightMap.h
void SetWeightedValue ( const FSolverVec2& InWeightedValue )	Set the low and high values of the weight map.	Chaos/PBDWeightMap.h

Name	Remarks	Include Path	Unreal Specifiers
void ApplyValues ( FunctorType&& MappingFunction, bool* bOutUpdated )		Chaos/PBDWeightMap.h

Name	Remarks	Include Path
operator FSolverReal()	Return the exponential stiffness value when the weight map is not used.	Chaos/PBDWeightMap.h
FSolverReal operator[] ( int32 Index ) const	Lookup for the exponential weighted value at the specified weight map index.	Chaos/PBDWeightMap.h
FPBDWeightMap & operator= ( const FPBDWeightMap& )		Chaos/PBDWeightMap.h
FPBDWeightMap & operator= ( FPBDWeightMap&& )		Chaos/PBDWeightMap.h