1. Epic GamesDeveloper
  3. FRigElementKeyCollection

FRigElementKeyCollection

API > API/Plugins > API/Plugins/ControlRig

   
Name FRigElementKeyCollection
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyDefines.h
Include Path #include "Rigs/RigHierarchyDefines.h"

Syntax

USTRUCT (BlueprintType )  
struct FRigElementKeyCollection

Constructors

Name Remarks Include Path Unreal Specifiers
  Rigs/RigHierarchyDefines.h  
  Rigs/RigHierarchyDefines.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Keys TArray< FRigElementKey >   Rigs/RigHierarchyDefines.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Collection

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 Add ( const FRigElementKey& InKey
)

   Rigs/RigHierarchyDefines.h  

int32 AddUnique ( const FRigElementKey& InKey
)

   Rigs/RigHierarchyDefines.h  

TArray< FRigElementKey >::RangedForConstIteratorType begin ()

   Rigs/RigHierarchyDefines.h  

TArray< FRigElementKey >::RangedForIteratorType begin ()

   Rigs/RigHierarchyDefines.h  

bool Contains ( const FRigElementKey& InKey
) const

   Rigs/RigHierarchyDefines.h  

void Empty()

 Resets the data structure and removes all storage. Rigs/RigHierarchyDefines.h  

TArray< FRigElementKey >::RangedForConstIteratorType end ()

   Rigs/RigHierarchyDefines.h  

TArray< FRigElementKey >::RangedForIteratorType end ()

   Rigs/RigHierarchyDefines.h  

FRigElementKeyCollection FilterByName ( const FName& InPartialName
) const

 Filters a collection by name Rigs/RigHierarchyDefines.h  

FRigElementKeyCollection FilterByType ( uint8 InElementTypes
) const

 Filters a collection by element type Rigs/RigHierarchyDefines.h  
Returns the first element of this collection. Rigs/RigHierarchyDefines.h  

const FRigElementKey & First ()

 Returns the first element of this collection. Rigs/RigHierarchyDefines.h  

const TArray< FRigElementKey > & GetKeys()

   Rigs/RigHierarchyDefines.h  

bool IsEmpty()

 Returns true if this collection contains no elements. Rigs/RigHierarchyDefines.h  

bool IsValidIndex ( int32 InIndex
) const

 Returns true if a given instruction index is valid. Rigs/RigHierarchyDefines.h  
Returns the last element of this collection. Rigs/RigHierarchyDefines.h  

const FRigElementKey & Last ()

 Returns the last element of this collection. Rigs/RigHierarchyDefines.h  

int32 Num()

 Returns the number of elements in this collection. Rigs/RigHierarchyDefines.h  

void Reset()

 Resets the data structure and maintains all storage. Rigs/RigHierarchyDefines.h  

Static

Name Remarks Include Path Unreal Specifiers

static FRigElementKeyCollection MakeDifference ( const FRigElementKeyCollection& A,
const FRigElementKeyCollection& B
)

 Returns the difference between two collections Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeFromChain ( URigHierarchy* InHierarchy,
const FRigElementKey& InFirstItem,
const FRigElementKey& InLastItem,
bool bReverse
)

 Creates a collection containing an item chain Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeFromChildren ( URigHierarchy* InHierarchy,
const FRigElementKey& InParentKey,
bool bRecursive,
bool bIncludeParent,
uint8 InElementTypes
)

 Creates a collection containing all of the children of a given Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeFromCompleteHierarchy ( URigHierarchy* InHierarchy,
uint8 InElementTypes
)

 Creates a collection containing all keys of a hierarchy Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeFromName ( URigHierarchy* InHierarchy,
const FName& InPartialName,
uint8 InElementTypes
)

 Creates a collection containing all of the elements with a given name Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeIntersection ( const FRigElementKeyCollection& A,
const FRigElementKeyCollection& B
)

 Returns the intersection between two collections Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeReversed ( const FRigElementKeyCollection& InCollection
)

 Returns the collection in the reverse order Rigs/RigHierarchyDefines.h  

static FRigElementKeyCollection MakeUnion ( const FRigElementKeyCollection& A,
const FRigElementKeyCollection& B,
bool bAllowDuplicates
)

 Returns the union between two collections Rigs/RigHierarchyDefines.h  

Operators

Name Remarks Include Path Unreal Specifiers

const FRigElementKey & operator[] ( int32 InIndex
) const

 Const accessor for an element given its index Rigs/RigHierarchyDefines.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page