Navigation
API > API/Runtime > API/Runtime/Chaos
A handle to an item held by index in a container. The container must provide the following API: - int NumItems() const;
- bool IsValid(int32 Index) const;
- FItem* TryGetItem(int32 Index);
- const FItem* TryGetItem(int32 Index) const;
- FItem& GetItem(int32 Index);
- const FItem& GetItem(int32 Index) const;
| Name | TConstContainerItemHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/ContainerItemHandle.h |
| Include Path | #include "Chaos/Framework/ContainerItemHandle.h" |
Syntax
template<typename T_CONTAINER, typename T_ITEM>
class TConstContainerItemHandle
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chaos/Framework/ContainerItemHandle.h | |||
TConstContainerItemHandle
(
const T_CONTAINER& InContainer, |
Chaos/Framework/ContainerItemHandle.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FContainer | T_CONTAINER | Chaos/Framework/ContainerItemHandle.h | |
| FHandle | TConstContainerItemHandle< FContainer, FItem > | Chaos/Framework/ContainerItemHandle.h | |
| FItem | T_ITEM | Chaos/Framework/ContainerItemHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Container | const FContainer * | Chaos/Framework/ContainerItemHandle.h | ||
| Index | int | Chaos/Framework/ContainerItemHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FItem & Get() |
Chaos/Framework/ContainerItemHandle.h | ||
const FContainer * GetContainer() |
Chaos/Framework/ContainerItemHandle.h | ||
int GetIndex() |
Chaos/Framework/ContainerItemHandle.h | ||
bool IsValid() |
Chaos/Framework/ContainerItemHandle.h | ||
void Reset() |
Chaos/Framework/ContainerItemHandle.h | ||
const FItem * TryGet() |
Chaos/Framework/ContainerItemHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FItem & operator*() |
Chaos/Framework/ContainerItemHandle.h | ||
const FItem * operator->() |
Chaos/Framework/ContainerItemHandle.h |