Navigation
API > API/Runtime > API/Runtime/Chaos
Defines common API for reading and writing simulation properties data and metadata. This is mainly used for the cloth simulation properties to provide weighted values that works in conjunction with weight maps.
Note: Int property values are stored as float and therefore limited to 24 bits (-16777215 to 16777215).
| Name | FCollectionPropertyFacade |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/CollectionPropertyFacade.h |
| Include Path | #include "Chaos/CollectionPropertyFacade.h" |
Syntax
class FCollectionPropertyFacade : public Chaos::Softs::FCollectionPropertyConstFacade
Inheritance Hierarchy
- FCollectionPropertyConstFacade → FCollectionPropertyFacade
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCollectionPropertyFacade
(
const TSharedPtr< FManagedArrayCollection >& InManagedArrayCollection, |
No init constructor for FCollectionPropertyMutableFacade. | Chaos/CollectionPropertyFacade.h | |
| Chaos/CollectionPropertyFacade.h | |||
FCollectionPropertyFacade
(
const TSharedPtr< FManagedArrayCollection >& InManagedArrayCollection |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h | |||
| Chaos/CollectionPropertyFacade.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCollectionPropertyFacade() |
Chaos/CollectionPropertyFacade.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearDirtyFlags() |
Chaos/CollectionPropertyFacade.h | ||
void SetAnimatable
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetAnimatable
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetAnimatable
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetDirty
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h | |||
int32 SetDirty
(
const StringType Key |
Chaos/CollectionPropertyFacade.h | ||
void SetEnabled
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetEnabled
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetEnabled
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetFlags
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetFlags
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetFlags
(
int32 KeyIndex, |
SetFlags cannot be used to remove Dirty, StringDirty, Interpolable or Intrinsic flags. | Chaos/CollectionPropertyFacade.h | |
void SetHighValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetHighValue
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetHighValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetInterpolable
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
int32 SetInterpolable
(
const FName& Key |
Chaos/CollectionPropertyFacade.h | ||
int32 SetInterpolable
(
const StringType Key |
Chaos/CollectionPropertyFacade.h | ||
void SetIntrinsic
(
int32 KeyIndex |
Set the intrinsic flag for this property. This flag cannot be removed and implies non Animatable. | Chaos/CollectionPropertyFacade.h | |
int32 SetIntrinsic
(
const FName& Key |
Set the intrinsic flag for this property. This flag cannot be removed and implies non Animatable. | Chaos/CollectionPropertyFacade.h | |
int32 SetIntrinsic
(
const StringType Key |
Set the intrinsic flag for this property. This flag cannot be removed and implies non Animatable. | Chaos/CollectionPropertyFacade.h | |
void SetLegacy
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h | |||
int32 SetLegacy
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetLowValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetLowValue
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetLowValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
void SetStringDirty
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
int32 SetStringDirty
(
const FName& Key |
Chaos/CollectionPropertyFacade.h | ||
int32 SetStringDirty
(
const StringType Key |
Chaos/CollectionPropertyFacade.h | ||
void SetStringValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetStringValue
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetStringValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h | |||
int32 SetValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetWeightedFloatValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetWeightedFloatValue
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetWeightedFloatValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
void SetWeightedValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetWeightedValue
(
const StringType Key, |
Chaos/CollectionPropertyFacade.h | ||
int32 SetWeightedValue
(
const FName& Key, |
Chaos/CollectionPropertyFacade.h | ||
void UpdateProperties
(
const TSharedPtr< const FManagedArrayCollection >& InManagedArrayCollection |
Chaos/CollectionPropertyFacade.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TArrayView< ECollectionPropertyFlags > & GetFlagsArray() |
Chaos/CollectionPropertyFacade.h | ||
const TArrayView< FVector3f > & GetHighValueArray() |
Chaos/CollectionPropertyFacade.h | ||
const TArrayView< FString > & GetKeyArray() |
Chaos/CollectionPropertyFacade.h | ||
const TArrayView< FName > & GetKeyNameArray() |
Chaos/CollectionPropertyFacade.h | ||
const TArrayView< FVector3f > & GetLowValueArray() |
Chaos/CollectionPropertyFacade.h | ||
TSharedPtr< FManagedArrayCollection > GetManagedArrayCollection() |
Access to a writeable ManagedArrayCollection is protected, use an FPropertyCollectionMutableAdapter if needed to get a non const pointer. | Chaos/CollectionPropertyFacade.h | |
const TArrayView< FString > & GetStringValueArray() |
Chaos/CollectionPropertyFacade.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCollectionPropertyFacade & operator=
(
const FCollectionPropertyFacade& |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h |