1. Epic GamesDeveloper
  3. FRigElementKeyCollection

FRigElementKeyCollection

Unreal Engine C++ API Reference > Plugins > ControlRig > Rigs

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FRigElementKeyCollection

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FRigElementKey > Keys  

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function int32

Add ( const FRigElementKey& InKey
)

  
Public function int32

AddUnique ( const FRigElementKey& InKey
)

  
Public function Const TArray< FRigElementKey >::RangedForConstIteratorType

begin ()

  
Public function TArray< FRigElementKey >::RangedForIteratorType

begin ()

  
Public function Const bool

Contains ( const FRigElementKey& InKey
)

  
Public function void

Empty ()

 Resets the data structure and removes all storage.
Public function Const TArray< FRigElementKey >::RangedForConstIteratorType

end ()

  
Public function TArray< FRigElementKey >::RangedForIteratorType

end ()

  
Public function Const FRigElementKeyCollection

FilterByName ( const FName& InPartialName
)

 Filters a collection by name
Public function Const FRigElementKeyCollection

FilterByType ( uint8 InElementTypes
)

 Filters a collection by element type
Public function FRigElementKey &

First ()

 Returns the first element of this collection.
Public function Const const FRigElementKey &

First ()

 Returns the first element of this collection.
Public function Const const TArray< FRigElementKey > &

GetKeys ()

  
Public function Const bool

IsEmpty ()

 Returns true if this collection contains no elements.
Public function Const bool

IsValidIndex ( int32 InIndex
)

 Returns true if a given instruction index is valid.
Public function FRigElementKey &

Last ()

 Returns the last element of this collection.
Public function Const const FRigElementKey &

Last ()

 Returns the last element of this collection.
Public function Static FRigElementKeyCollection Returns the difference between two collections
Public function Static FRigElementKeyCollection

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

 Creates a collection containing an item chain
Public function 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
Public function Static FRigElementKeyCollection

MakeFromCompleteHierarchy ( URigHierarchy* InHierarchy,
uint8 InElementTypes
)

 Creates a collection containing all keys of a hierarchy
Public function Static FRigElementKeyCollection

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

 Creates a collection containing all of the elements with a given name
Public function Static FRigElementKeyCollection Returns the intersection between two collections
Public function Static FRigElementKeyCollection

MakeReversed ( const FRigElementKeyCollection& InCollection
)

 Returns the collection in the reverse order
Public function Static FRigElementKeyCollection

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

 Returns the union between two collections
Public function Const int32

Num ()

 Returns the number of elements in this collection.
Public function void

Reset ()

 Resets the data structure and maintains all storage.

Operators

  Type Name Description
Public function Const const FRigElementKey &

operator[] ( int32 InIndex
)

 Const accessor for an element given its index

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page