1. Epic GamesDeveloper
  3. FControlRigOverrideContainer

FControlRigOverrideContainer

A container to represent a set of override values for one or more subjects.

API > API/Plugins > API/Plugins/ControlRig

A container to represent a set of override values for one or more subjects. The bUsesKeyForSubject setting will control if the subject name is respected when adding / looking up / applying overrides. This data-structure is not thread-safe for writing.

   
Name FControlRigOverrideContainer
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ControlRigOverride.h
Include Path #include "ControlRigOverride.h"

Syntax

USTRUCT (BlueprintType )  
struct FControlRigOverrideContainer

Constructors

Name Remarks Include Path Unreal Specifiers

FControlRigOverrideContainer()

   ControlRigOverride.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bUsesKeyForSubject bool   ControlRigOverride.h  
ContainsChildPathCache TMap< uint32, bool >   ControlRigOverride.h  
ContainsParentPathCache TMap< uint32, bool >   ControlRigOverride.h  
HashIndexLookup TMap< uint32, int32 >   ControlRigOverride.h  
SubjectIndexLookup TMap< FName, TArray< int32 > >   ControlRigOverride.h  
Values TArray< FControlRigOverrideValue >   ControlRigOverride.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 Add ( const FControlRigOverrideValue& InValue
)

   ControlRigOverride.h  

void AddStructReferencedObjects ( FReferenceCollector& Collector
)

   ControlRigOverride.h  

TArray< FControlRigOverrideValue >::RangedForConstIteratorType begin ()

   ControlRigOverride.h  

TArray< FControlRigOverrideValue >::RangedForIteratorType begin ()

   ControlRigOverride.h  

bool Contains ( const FString& InPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

bool Contains ( const FControlRigOverrideValue& InOverrideValue
) const

   ControlRigOverride.h  

bool ContainsAnyPathForSubject ( const FName& InSubjectKey
) const

   ControlRigOverride.h  

bool ContainsChildPathOf ( const FString& InParentPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

bool ContainsChildPathOf ( const FControlRigOverrideValue& InOverrideValue
) const

   ControlRigOverride.h  

bool ContainsParentPathOf ( const FString& InChildPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

bool ContainsParentPathOf ( const FControlRigOverrideValue& InOverrideValue
) const

   ControlRigOverride.h  

bool ContainsPathForAnySubject ( const FString& InPath
) const

   ControlRigOverride.h  

void CopyToSubject ( void* InSubjectPtr,
const UStruct* InSubjectStruct,
const FName& InSubjectKey
) const

 Copies the override values onto a subject. ControlRigOverride.h  

void CopyToUObject ( UObject* InSubjectPtr
) const

 Copies the override values onto a subject. ControlRigOverride.h  

int32 Emplace ( const FString& InPath,
const UObject* InSubject
)

   ControlRigOverride.h  

int32 Emplace ( const FString& InPath,
const UStruct* InOwnerStruct,
const void* InSubjectPtr,
const FName& InSubjectKey
)

   ControlRigOverride.h  

int32 Emplace ( const FString& InPath,
const UStruct* InOwnerStruct,
const FString& InValueAsString,
const FName& InSubjectKey
)

   ControlRigOverride.h  

void Empty()

   ControlRigOverride.h  

TArray< FControlRigOverrideValue >::RangedForIteratorType end ()

   ControlRigOverride.h  

TArray< FControlRigOverrideValue >::RangedForConstIteratorType end ()

   ControlRigOverride.h  

const FControlRigOverrideValue * Find ( const FString& InPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

FControlRigOverrideValue * Find ( const FString& InPath,
const FName& InSubjectKey
)

   ControlRigOverride.h  

FControlRigOverrideValue & FindChecked ( const FString& InPath,
const FName& InSubjectKey
)

   ControlRigOverride.h  

const FControlRigOverrideValue & FindChecked ( const FString& InPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

const FControlRigOverrideValue * FindOrAdd ( const FControlRigOverrideValue& InValue
)

   ControlRigOverride.h  

TArray< FName > GenerateSubjectArray()

   ControlRigOverride.h  

int32 GetIndex ( const FString& InPath,
const FName& InSubjectKey
) const

   ControlRigOverride.h  

const TArray< int32 > * GetIndicesForSubject ( const FName& InSubjectKey
) const

   ControlRigOverride.h  

bool Identical ( const FControlRigOverrideContainer* Other,
uint32 PortFlags
) const

   ControlRigOverride.h  

bool IsEmpty()

   ControlRigOverride.h  

bool IsValidIndex ( int32 InIndex
) const

   ControlRigOverride.h  

int32 Num()

   ControlRigOverride.h  

bool Remove ( const FString& InPath,
const FName& InSubjectKey
)

   ControlRigOverride.h  

bool Remove ( const FControlRigOverrideValue& InValue
)

   ControlRigOverride.h  

bool RemoveAll ( const FName& InSubjectKey
)

   ControlRigOverride.h  

void Reserve ( int32 InNum
)

   ControlRigOverride.h  

void Reset()

   ControlRigOverride.h  

bool Serialize ( FArchive& Ar
)

   ControlRigOverride.h  

void SetFromSubject ( const void* InSubjectPtr,
const UStruct* InSubjectStruct,
const FName& InSubjectKey
)

 Copies the value from the subject into this container ControlRigOverride.h  

void SetFromUObject ( const UObject* InSubjectPtr
)

 Copies the value from the subject into this container ControlRigOverride.h  

void SetUsesKeyForSubject ( bool InUsesKeyForSubject
)

   ControlRigOverride.h  

bool UsesKeyForSubject()

   ControlRigOverride.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString GetParentPath ( const FString& InChildPath
)

 Returns a parent path of a given child path, separators used are -> and [, so parent of 'Values[1]->Flag' is 'Values[1]', and parent of 'Values[1]' is 'Values'. ControlRigOverride.h  

static bool IsChildPathOf ( const FString& InChildPath,
const FString& InParentPath
)

 Returns true if a given child path is a child of a given parent path ControlRigOverride.h  

Operators

Name Remarks Include Path Unreal Specifiers

const FControlRigOverrideValue & operator[] ( int32 InIndex
) const

   ControlRigOverride.h  

FControlRigOverrideValue & operator[] ( int32 InIndex
)

   ControlRigOverride.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page