Navigation
API > API/Editor > API/Editor/AnimationEditorWidgets
The subject of an override status (widget). To support multi selection the subject is represented by an array of objects and a property path. This class also offers helper template functions to facilitate the interaction between the list of subject object and the user interface layer.
| Name | FOverrideStatusSubject |
| Type | struct |
| Header File | /Engine/Source/Editor/AnimationEditorWidgets/Public/Overrides/OverrideStatusSubject.h |
| Include Path | #include "Overrides/OverrideStatusSubject.h" |
Syntax
struct FOverrideStatusSubject
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOverrideStatusSubject
(
const TArray< FOverrideStatusObject >& InObjects, |
Overrides/OverrideStatusSubject.h | ||
FOverrideStatusSubject
(
const FOverrideStatusObject& InObject, |
Overrides/OverrideStatusSubject.h | ||
FOverrideStatusSubject
(
const UObject* InObject, |
Overrides/OverrideStatusSubject.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Category | FName | Overrides/OverrideStatusSubject.h | ||
| LastPropertyPathString | TOptional< FString > | Overrides/OverrideStatusSubject.h | ||
| LastSeparator | TOptional< FString > | Overrides/OverrideStatusSubject.h | ||
| Objects | TArray< FOverrideStatusObject > | Overrides/OverrideStatusSubject.h | ||
| PropertyPath | TSharedPtr< const FPropertyPath > | Overrides/OverrideStatusSubject.h | ||
| SubObjectKey | FName | Overrides/OverrideStatusSubject.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FOverrideStatusObject >::RangedForConstIteratorType begin() |
Range access | Overrides/OverrideStatusSubject.h | |
bool Contains
(
TFunction< bool(const FOverrideStatusObjectHandle< ObjectType >&)> InMatchPredicate |
Returns true if the subject contains an object matching the given predicate | Overrides/OverrideStatusSubject.h | |
bool Contains
(
const FOverrideStatusObject& InObject |
Returns true if a given object is part of the subject | Overrides/OverrideStatusSubject.h | |
bool Contains () |
Returns true if the subject contains an object of type ObjectType | Overrides/OverrideStatusSubject.h | |
TArray< FOverrideStatusObject >::RangedForConstIteratorType end() |
Overrides/OverrideStatusSubject.h | ||
int32 Find
(
TFunction< bool(const FOverrideStatusObjectHandle< ObjectType >&)> InMatchPredicate |
Returns the index of a given object or INDEX_NONE, the match is determined based on the given predicate | Overrides/OverrideStatusSubject.h | |
int32 Find
(
const FOverrideStatusObject& InObject |
Returns the index of a given object or INDEX_NONE | Overrides/OverrideStatusSubject.h | |
void ForEach
(
TFunction< void(const FOverrideStatusObjectHandle< ObjectType >&)> InPerObjectPredicate |
Executes a given predicate for each object in the subject | Overrides/OverrideStatusSubject.h | |
const FName & GetCategory() |
Getter for category | Overrides/OverrideStatusSubject.h | |
TOptional< ValueType > GetCommonValue
(
TFunction< TOptional< ValueType >(const FOverrideStatusObjectHandle< ObjectType >&)> InGetValuePerO... |
Returns a common for a given predicate (or an unset TOptional). | Overrides/OverrideStatusSubject.h | |
TOptional< ValueType > GetFirstValue
(
TFunction< TOptional< ValueType >(const FOverrideStatusObjectHandle< ObjectType >&)> InGetValuePerO... |
Returns the first valid value for a given predicate (or an unset TOptional). | Overrides/OverrideStatusSubject.h | |
FOverrideStatusObjectHandle< T > GetHandle
(
int32 InIndex |
Array handle access | Overrides/OverrideStatusSubject.h | |
const TSharedPtr< const FPropertyPath > & GetPropertyPath() |
Getter for the property path | Overrides/OverrideStatusSubject.h | |
const FString & GetPropertyPathString
(
const TCHAR* Separator |
Getter for the propery path string (uses a cache inside and is faster than GetPropertyPath()->ToString()) | Overrides/OverrideStatusSubject.h | |
TOptional< EOverrideWidgetStatus::Type > GetStatus
(
TFunction< TOptional< EOverrideWidgetStatus::Type >(const FOverrideStatusObjectHandle< ObjectType > ... |
Returns the status provided by the subject's objects or an empty TOptional if it varies across objects | Overrides/OverrideStatusSubject.h | |
bool HasCategory() |
Returns true if this subject is linked to a category | Overrides/OverrideStatusSubject.h | |
bool HasPropertyPath() |
Returns true if this subject contains a property path | Overrides/OverrideStatusSubject.h | |
bool IsValid() |
Returns true if any of the objects within the subject is still valid | Overrides/OverrideStatusSubject.h | |
int32 Num() |
Returns the number of objects | Overrides/OverrideStatusSubject.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FOverrideStatusObject & operator[]
(
int32 InIndex |
Array access operator | Overrides/OverrideStatusSubject.h |