Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ControlRig > Rigs > FRigElementKeyCollection

Light Theme

Dark Theme

FRigElementKeyCollection

Windows

MacOS

Linux

References

Module	ControlRig
Header	/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyDefines.h
Include	#include "Rigs/RigHierarchyDefines.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FRigElementKeyCollection

Variables

		Name	Description
	TArray< FRigEle...	Keys

Constructors

	Name	Description
	FRigElementKeyCollection()
	FRigElementKeyCollection ( const TArray< FRigElementKey >& In... )

Functions

	Name	Description
int32	Add ( const FRigElementKey& InKey )
int32	AddUnique ( const FRigElementKey& InKey )
TArray< FRig...	begin()
TArray< FRig...	begin()
bool	Contains ( const FRigElementKey& InKey )
void	Empty()	Resets the data structure and removes all storage.
TArray< FRig...	end()
TArray< FRig...	end()
FRigElementK...	FilterByName ( const FName& InPartialName )	Filters a collection by name
FRigElementK...	FilterByType ( uint8 InElementTypes )	Filters a collection by element type
FRigElementK...	First()	Returns the first element of this collection.
const FRigEl...	First()	Returns the first element of this collection.
bool	IsEmpty()	Returns true if this collection contains no elements.
bool	IsValidIndex ( int32 InIndex )	Returns true if a given instruction index is valid.
FRigElementK...	Last()	Returns the last element of this collection.
const FRigEl...	Last()	Returns the last element of this collection.
FRigElementK...	MakeDifference ( const FRigElementKeyCollection& A, const FRigElementKeyCollection& B )	Returns the difference between two collections
FRigElementK...	MakeFromChain ( const FRigHierarchyContainer* ..., const FRigElementKey& InFirstItem, const FRigElementKey& InLastItem, bool bReverse )	Creates a collection containing an item chain
FRigElementK...	MakeFromChildren ( const FRigHierarchyContainer* ..., const FRigElementKey& InParentKey, bool bRecursive, bool bIncludeParent, uint8 InElementTypes )	Creates a collection containing all of the children of a given
FRigElementK...	MakeFromCompleteHierarchy ( const FRigHierarchyContainer* ..., uint8 InElementTypes )	Creates a collection containing all keys of a hierarchy
FRigElementK...	MakeFromName ( const FRigHierarchyContainer* ..., const FName& InPartialName, uint8 InElementTypes )	Creates a collection containing all of the elements with a given name
FRigElementK...	MakeIntersection ( const FRigElementKeyCollection& A, const FRigElementKeyCollection& B )	Returns the intersection between two collections
FRigElementK...	MakeReversed ( const FRigElementKeyCollection& In... )	Returns the collection in the reverse order
FRigElementK...	MakeUnion ( const FRigElementKeyCollection& A, const FRigElementKeyCollection& B )	Returns the union between two collections
int32	Num()	Returns the number of elements in this collection.
void	Reset()	Resets the data structure and maintains all storage.

Operators

		Name	Description
	const FRigEl...	operator[] ( int32 InIndex )	Const accessor for an element given its index

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss