UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Friends | List of all members
Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM > Class Template Reference

#include <ContainerItemHandle.h>

+ Inheritance diagram for Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >:

Public Types

using Base = TConstContainerItemHandle< T_CONTAINER, T_ITEM >
 
using FContainer = T_CONTAINER
 
using FItem = T_ITEM
 
using FHandle = TContainerItemHandle< FContainer, FItem >
 

Public Member Functions

 TContainerItemHandle ()
 
 TContainerItemHandle (T_CONTAINER &InContainer, int InIndex)
 
 operator const TConstContainerItemHandle< T_CONTAINER, T_ITEM > & () const
 
FItem * TryGet () const
 
FItem & Get () const
 
FItem * operator-> () const
 
FItem & operator* () const
 
FContainer * GetContainer () const
 
bool IsValid () const
 
void Reset ()
 
int GetIndex () const
 

Friends

bool operator== (const FHandle &L, const FHandle &R)
 
bool operator!= (const FHandle &L, const FHandle &R)
 
bool operator< (const FHandle &L, const FHandle &R)
 

Detailed Description

template<typename T_CONTAINER, typename T_ITEM>
class Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >

Same as TConstContainerItemHandle but for non-const containers/items

Member Typedef Documentation

◆ Base

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::Base = TConstContainerItemHandle<T_CONTAINER, T_ITEM>

◆ FContainer

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::FContainer = T_CONTAINER

◆ FHandle

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::FHandle = TContainerItemHandle<FContainer, FItem>

◆ FItem

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::FItem = T_ITEM

Constructor & Destructor Documentation

◆ TContainerItemHandle() [1/2]

template<typename T_CONTAINER , typename T_ITEM >
Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::TContainerItemHandle ( )
inline

◆ TContainerItemHandle() [2/2]

template<typename T_CONTAINER , typename T_ITEM >
Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::TContainerItemHandle ( T_CONTAINER &  InContainer,
int  InIndex 
)
inline

Member Function Documentation

◆ Get()

template<typename T_CONTAINER , typename T_ITEM >
FItem & Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::Get ( ) const
inline

◆ GetContainer()

template<typename T_CONTAINER , typename T_ITEM >
FContainer * Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::GetContainer ( ) const
inline

◆ GetIndex()

template<typename T_CONTAINER , typename T_ITEM >
int Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::GetIndex ( ) const
inline

◆ IsValid()

template<typename T_CONTAINER , typename T_ITEM >
bool Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::IsValid ( ) const
inline

◆ operator const TConstContainerItemHandle< T_CONTAINER, T_ITEM > &()

template<typename T_CONTAINER , typename T_ITEM >
Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::operator const TConstContainerItemHandle< T_CONTAINER, T_ITEM > & ( ) const
inline

◆ operator*()

template<typename T_CONTAINER , typename T_ITEM >
FItem & Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::operator* ( ) const
inline

◆ operator->()

template<typename T_CONTAINER , typename T_ITEM >
FItem * Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::operator-> ( ) const
inline

◆ Reset()

template<typename T_CONTAINER , typename T_ITEM >
void Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::Reset ( )
inline

◆ TryGet()

template<typename T_CONTAINER , typename T_ITEM >
FItem * Chaos::TContainerItemHandle< T_CONTAINER, T_ITEM >::TryGet ( ) const
inline

Friends And Related Symbol Documentation

◆ operator!=

template<typename T_CONTAINER , typename T_ITEM >
bool operator!= ( const FHandle &  L,
const FHandle &  R 
)
friend

◆ operator<

template<typename T_CONTAINER , typename T_ITEM >
bool operator< ( const FHandle &  L,
const FHandle &  R 
)
friend

◆ operator==

template<typename T_CONTAINER , typename T_ITEM >
bool operator== ( const FHandle &  L,
const FHandle &  R 
)
friend
The documentation for this class was generated from the following file: