Navigation
API > API/Runtime > API/Runtime/ClothingSystemRuntimeCommon
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
| Name | FPointWeightMap |
| Type | struct |
| Header File | /Engine/Source/Runtime/ClothingSystemRuntimeCommon/Public/PointWeightMap.h |
| Include Path | #include "PointWeightMap.h" |
Syntax
USTRUCT ()
struct FPointWeightMap
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| PointWeightMap.h | |||
FPointWeightMap
(
const TConstArrayView< float >& InValues |
PointWeightMap.h | ||
FPointWeightMap
(
int32 NumPoints, |
PointWeightMap.h | ||
FPointWeightMap
(
const TConstArrayView< float >& InValues, |
PointWeightMap.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FPointWeightMap() |
PointWeightMap.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnabled | bool | Whether this mask is enabled and able to effect final mesh values | PointWeightMap.h | |
| CurrentTarget | uint8 | The currently targeted parameter for the mask, @seealso EWeightMapTargetCommon | PointWeightMap.h | |
| Name | FName | Name of the mask, mainly for users to differentiate | PointWeightMap.h | |
| Values | TArray< float > | The actual values stored in the mask | PointWeightMap.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AreAllBelowThreshold
(
const int32 Index0, |
Return whether all of the specified triangle points have weight below (or equal) to the specified | PointWeightMap.h | |
bool AreAnyBelowThreshold
(
const int32 Index0, |
Return whether at least one of the specified triangle points has weight below (or equal) to the specified | PointWeightMap.h | |
void CalcRanges
(
float& MinValue, |
Calculates Min/Max values based on values. | PointWeightMap.h | |
void Empty() |
Empty this map of any values. | PointWeightMap.h | |
float GetValue
(
int32 Index |
Get a value from the map, or return 0 if the index is out of bounds. | PointWeightMap.h | |
void Initialize
(
const FPointWeightMap& Source, |
Initialize a weight map from another weight map while enabling and setting a new target. | PointWeightMap.h | |
void Initialize
(
const int32 NumPoints |
Reset this map to the specified number of points, and set all the values to zero. | PointWeightMap.h | |
bool IsBelowThreshold
(
const int32 Index, |
Return whether the specified point weight is below (or equal) to the specified threshold. | PointWeightMap.h | |
bool IsZeroed() |
Return whether all points' values are zero. | PointWeightMap.h | |
int32 Num() |
Return the number of values in this map. | PointWeightMap.h | |
void SetValue
(
int32 Index, |
Set a value in the map checking first whether the index is within bounds. | PointWeightMap.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const float & operator[]
(
int32 Index |
Return the current float value for the requested point. | PointWeightMap.h | |
float & operator[]
(
int32 Index |
Return the current float value for the requested point. | PointWeightMap.h |