Navigation
API > API/Runtime > API/Runtime/Chaos
Defines common API for reading 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.
| Name | FCollectionPropertyConstFacade |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/CollectionPropertyFacade.h |
| Include Path | #include "Chaos/CollectionPropertyFacade.h" |
Syntax
class FCollectionPropertyConstFacade
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCollectionPropertyConstFacade
(
const TSharedPtr< const FManagedArrayCollection >& InManagedArrayCollection, |
No init constructor for FCollectionPropertyFacade. | Chaos/CollectionPropertyFacade.h | |
| Chaos/CollectionPropertyFacade.h | |||
| Chaos/CollectionPropertyFacade.h | |||
FCollectionPropertyConstFacade
(
const TSharedPtr< const FManagedArrayCollection >& InManagedArrayCollection |
Chaos/CollectionPropertyFacade.h | ||
| Chaos/CollectionPropertyFacade.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCollectionPropertyConstFacade() |
Chaos/CollectionPropertyFacade.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FlagsName | const FName | Chaos/CollectionPropertyFacade.h | |
| HighValueName | const FName | Chaos/CollectionPropertyFacade.h | |
| KeyName | const FName | Chaos/CollectionPropertyFacade.h | |
| LowValueName | const FName | Chaos/CollectionPropertyFacade.h | |
| PropertyGroup | const FName | Attribute groups, predefined data member of the collection. | Chaos/CollectionPropertyFacade.h |
| StringValueName | const FName | Chaos/CollectionPropertyFacade.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ECollectionPropertyFlags GetFlags
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
ECollectionPropertyFlags GetFlags
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
T GetHighValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
T GetHighValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
const FString & GetKey
(
int32 KeyIndex |
Return the property name (key) for the specified index. | Chaos/CollectionPropertyFacade.h | |
int32 GetKeyIndex
(
const FString& Key |
Return the property index for the specified key if it exists, or INDEX_NONE otherwise. | Chaos/CollectionPropertyFacade.h | |
T GetLowValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
T GetLowValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
const FString & GetStringValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
FString GetStringValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
friend::uint32 GetTypeHash
(
const Chaos::Softs::FCollectionPropertyConstFacade& PropertyFacade |
Chaos/CollectionPropertyFacade.h | ||
T GetValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
CHAOS_APIint32 GetValue
(
int32 KeyIndex, |
|||
CHAOS_API float GetValue
(
int32 KeyIndex, |
|||
T GetValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
CHAOS_API bool GetValue
(
int32 KeyIndex, |
|||
FVector2f GetWeightedFloatValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
FVector2f GetWeightedFloatValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
FVector2f GetWeightedFloatValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
TPair< T, T > GetWeightedValue
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
TPair< T, T > GetWeightedValue
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsAnimatable
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsAnimatable
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsDirty
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsDirty
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsEnabled
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsEnabled
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsInterpolable
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsInterpolable
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsIntrinsic
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsIntrinsic
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsLegacy
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsLegacy
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsStringDirty
(
int32 KeyIndex |
Chaos/CollectionPropertyFacade.h | ||
bool IsStringDirty
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
bool IsValid() |
Return whether the facade is defined on the collection. | Chaos/CollectionPropertyFacade.h | |
int32 Num() |
Return the number of properties in this collection. | Chaos/CollectionPropertyFacade.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TConstArrayView< T > GetArray
(
const FName& Name |
Chaos/CollectionPropertyFacade.h | ||
T GetValue
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
bool HasAnyFlags
(
int32 KeyIndex, |
Chaos/CollectionPropertyFacade.h | ||
void RebuildKeyIndices() |
Rebuild the search map. | Chaos/CollectionPropertyFacade.h | |
ReturnType SafeGet
(
const FString& Key, |
Chaos/CollectionPropertyFacade.h | ||
void UpdateArrays() |
Update the array views. | Chaos/CollectionPropertyFacade.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chaos/CollectionPropertyFacade.h | |||
| Chaos/CollectionPropertyFacade.h |