FPointWeightMap Struct Reference

#include <PointWeightMap.h>

Public Member Functions
	GENERATED_BODY ()
	FPointWeightMap ()
	FPointWeightMap (int32 NumPoints, float Value=0.f)
	FPointWeightMap (const TConstArrayView< float > &InValues)
	FPointWeightMap (const TConstArrayView< float > &InValues, float Offset, float Scale)
	~FPointWeightMap ()
void	Initialize (const int32 NumPoints)
template<typename T >
void	Initialize (const FPointWeightMap &Source, T Target)
void	Empty ()
int32	Num () const
const float &	operator[] (int32 Index) const
float &	operator[] (int32 Index)
float	GetValue (int32 Index) const
void	SetValue (int32 Index, float Value)
bool	IsBelowThreshold (const int32 Index, const float Threshold=0.1f) const
bool	AreAnyBelowThreshold (const int32 Index0, const int32 Index1, const int32 Index2, const float Threshold=0.1f) const
bool	AreAllBelowThreshold (const int32 Index0, const int32 Index1, const int32 Index2, const float Threshold=0.1f) const
bool	IsZeroed () const
void	CalcRanges (float &MinValue, float &MaxValue)

Public Attributes
TArray< float >	Values

Detailed Description

A mask is simply some storage for a physical mesh parameter painted onto clothing. Used in the editor for users to paint onto and then target to a parameter, which is then later applied to a phys mesh

Constructor & Destructor Documentation

FPointWeightMap() [1/4]

FPointWeightMap::FPointWeightMap ( )

inline

FPointWeightMap() [2/4]

FPointWeightMap::FPointWeightMap ( int32  NumPoints, float  Value = 0.f  )

inlineexplicit

FPointWeightMap() [3/4]

FPointWeightMap::FPointWeightMap ( const TConstArrayView< float > &  InValues )

inlineexplicit

FPointWeightMap() [4/4]

FPointWeightMap::FPointWeightMap ( const TConstArrayView< float > &  InValues, float  Offset, float  Scale  )

inline

~FPointWeightMap()

FPointWeightMap::~FPointWeightMap ( )

inline

Member Function Documentation

AreAllBelowThreshold()

bool FPointWeightMap::AreAllBelowThreshold ( const int32  Index0, const int32  Index1, const int32  Index2, const float  Threshold = 0.1f  ) const

inline

Return whether all of the specified triangle points have weight below (or equal) to the specified

Parameters

Threshold.

AreAnyBelowThreshold()

bool FPointWeightMap::AreAnyBelowThreshold ( const int32  Index0, const int32  Index1, const int32  Index2, const float  Threshold = 0.1f  ) const

inline

Return whether at least one of the specified triangle points has weight below (or equal) to the specified

Parameters

Threshold.

CalcRanges()

void FPointWeightMap::CalcRanges ( float &  MinValue, float &  MaxValue  )

inline

Calculates Min/Max values based on values.

Empty()

void FPointWeightMap::Empty ( )

inline

Empty this map of any values.

GENERATED_BODY()

FPointWeightMap::GENERATED_BODY

(

)

GetValue()

float FPointWeightMap::GetValue ( int32  Index ) const

inline

Get a value from the map, or return 0 if the index is out of bounds.

Parameters

Index

the value/point index to retrieve

Initialize() [1/2]

template<typename T >

void FPointWeightMap::Initialize ( const FPointWeightMap &  Source, T  Target  )

inline

Initialize a weight map from another weight map while enabling and setting a new target.

Parameters

Source	the source weight map to copy the values from.
Target	the new weight map target.

Initialize() [2/2]

void FPointWeightMap::Initialize ( const int32  NumPoints )

inline

Reset this map to the specified number of points, and set all the values to zero.

Parameters

NumPoints

the number of points to initialize the map with.

IsBelowThreshold()

bool FPointWeightMap::IsBelowThreshold ( const int32  Index, const float  Threshold = 0.1f  ) const

inline

Return whether the specified point weight is below (or equal) to the specified threshold.

Parameters

Index	the value/point index to retrieve
Threshold,the	value threshold to test against for.

IsZeroed()

bool FPointWeightMap::IsZeroed ( ) const

inline

Return whether all points' values are zero.

Num()

int32 FPointWeightMap::Num ( ) const

inline

Return the number of values in this map.

operator[]() [1/2]

float & FPointWeightMap::operator[] ( int32  Index )

inline

Return the current float value for the requested point.

Parameters

Index

the value/point index to retrieve, must be within range or it will assert.

operator[]() [2/2]

const float & FPointWeightMap::operator[] ( int32  Index ) const

inline

Return the current float value for the requested point.

Parameters

Index

the value/point index to retrieve, must be within range or it will assert.

SetValue()

void FPointWeightMap::SetValue ( int32  Index, float  Value  )

inline

Set a value in the map checking first whether the index is within bounds.

Parameters

Index	the value/point index to set
Value	the value to set

Member Data Documentation

Values

TArray<float> FPointWeightMap::Values

The actual values stored in the mask

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/ClothingSystemRuntimeCommon/Public/PointWeightMap.h