FRigElementKeyCollection

Choose your operating system:

Windows

macOS

Linux

References

Module

ControlRig

Header

/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyDefines.h

Include

#include "Rigs/RigHierarchyDefines.h"

Syntax

USTRUCT(BlueprintType)
struct FRigElementKeyCollection

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TArray< FRigEle...

 

Keys

Constructors

Name Description

Public function

FRigElementKeyCollection()

Public function

FRigElementKeyCollection

(
    const TArray< FRigElementKey >& In...
)

Functions

Name Description

Public function

int32

 

Add

(
    const FRigElementKey& InKey
)

Public function

int32

 

AddUnique

(
    const FRigElementKey& InKey
)

Public function Const

TArray< FRig...

 

begin()

Public function

TArray< FRig...

 

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< FRig...

 

end()

Public function

TArray< FRig...

 

end()

Public function Const

FRigElementK...

 

FilterByName

(
    const FName& InPartialName
)

Filters a collection by name

Public function Const

FRigElementK...

 

FilterByType

(
    uint8 InElementTypes
)

Filters a collection by element type

Public function

FRigElementK...

 

First()

Returns the first element of this collection.

Public function Const

const FRigEl...

 

First()

Returns the first element of this collection.

Public function Const

const TArray...

 

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

FRigElementK...

 

Last()

Returns the last element of this collection.

Public function Const

const FRigEl...

 

Last()

Returns the last element of this collection.

Public function Static

FRigElementK...

 

MakeDifference

(
    const FRigElementKeyCollection& A,
    const FRigElementKeyCollection& B
)

Returns the difference between two collections

Public function Static

FRigElementK...

 

MakeFromChain

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

Creates a collection containing an item chain

Public function Static

FRigElementK...

 

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

FRigElementK...

 

MakeFromCompleteHierarchy

(
    URigHierarchy* InHierarchy,
    uint8 InElementTypes
)

Creates a collection containing all keys of a hierarchy

Public function Static

FRigElementK...

 

MakeFromName

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

Creates a collection containing all of the elements with a given name

Public function Static

FRigElementK...

 

MakeIntersection

(
    const FRigElementKeyCollection& A,
    const FRigElementKeyCollection& B
)

Returns the intersection between two collections

Public function Static

FRigElementK...

 

MakeReversed

(
    const FRigElementKeyCollection& In...
)

Returns the collection in the reverse order

Public function Static

FRigElementK...

 

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

Name Description

Public function Const

const FRigEl...

 

operator[]

(
    int32 InIndex
)

Const accessor for an element given its index