UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::TComponentPtr< T > Struct Template Reference

#include <MovieSceneComponentPtr.h>

+ Inheritance diagram for UE::MovieScene::TComponentPtr< T >:

Public Types

using ValueType = std::conditional_t< std::is_const_v< T >, typename TCallTraits< T >::ParamType, T & >
 

Public Member Functions

 TComponentPtr ()
 
 TComponentPtr (T *InComponentPtr)
 
 TComponentPtr (const TComponentPtr &RHS)=default
 
TComponentPtroperator= (const TComponentPtr &RHS)=default
 
 TComponentPtr (TComponentPtr &&RHS)
 
TComponentPtroperator= (TComponentPtr &&RHS)
 
 operator bool () const
 
bool IsValid () const
 
T * AsPtr () const
 
TArrayView< T > AsArray (int32 Num) const
 
TArrayView< T > Slice (int32 StartIndex, int32 Num) const
 
T * operator-> () const
 
ValueType operator* () const
 
ValueType operator[] (int32 Index) const
 
ValueType ComponentAtIndex (int32 Index) const
 
 operator T* () const
 

Protected Attributes

T * ComponentPtr
 

Detailed Description

template<typename T>
struct UE::MovieScene::TComponentPtr< T >

Facade for any component data type

Member Typedef Documentation

◆ ValueType

template<typename T >
using UE::MovieScene::TComponentPtr< T >::ValueType = std::conditional_t<std::is_const_v<T>, typename TCallTraits<T>::ParamType, T&>

Value type is either a T or const T& for read-only types, or T& for writeable types

Constructor & Destructor Documentation

◆ TComponentPtr() [1/4]

template<typename T >
UE::MovieScene::TComponentPtr< T >::TComponentPtr ( )
inline

◆ TComponentPtr() [2/4]

template<typename T >
UE::MovieScene::TComponentPtr< T >::TComponentPtr ( T *  InComponentPtr)
inlineexplicit

◆ TComponentPtr() [3/4]

template<typename T >
UE::MovieScene::TComponentPtr< T >::TComponentPtr ( const TComponentPtr< T > &  RHS)
default

◆ TComponentPtr() [4/4]

template<typename T >
UE::MovieScene::TComponentPtr< T >::TComponentPtr ( TComponentPtr< T > &&  RHS)
inline

Member Function Documentation

◆ AsArray()

template<typename T >
TArrayView< T > UE::MovieScene::TComponentPtr< T >::AsArray ( int32  Num) const
inline

Retrieve this component data as an array view of the specified size (usually the size will be FEntityAllocation::Num())

◆ AsPtr()

template<typename T >
T * UE::MovieScene::TComponentPtr< T >::AsPtr ( ) const
inline

Explicitly convert this component data to its underlying pointer type

◆ ComponentAtIndex()

template<typename T >
ValueType UE::MovieScene::TComponentPtr< T >::ComponentAtIndex ( int32  Index) const
inline

◆ IsValid()

template<typename T >
bool UE::MovieScene::TComponentPtr< T >::IsValid ( ) const
inline

◆ operator bool()

template<typename T >
UE::MovieScene::TComponentPtr< T >::operator bool ( ) const
inlineexplicit

◆ operator T*()

template<typename T >
UE::MovieScene::TComponentPtr< T >::operator T* ( ) const
inline

◆ operator*()

template<typename T >
ValueType UE::MovieScene::TComponentPtr< T >::operator* ( ) const
inline

◆ operator->()

template<typename T >
T * UE::MovieScene::TComponentPtr< T >::operator-> ( ) const
inline

◆ operator=() [1/2]

template<typename T >
TComponentPtr & UE::MovieScene::TComponentPtr< T >::operator= ( const TComponentPtr< T > &  RHS)
default

◆ operator=() [2/2]

template<typename T >
TComponentPtr & UE::MovieScene::TComponentPtr< T >::operator= ( TComponentPtr< T > &&  RHS)
inline

◆ operator[]()

template<typename T >
ValueType UE::MovieScene::TComponentPtr< T >::operator[] ( int32  Index) const
inline

◆ Slice()

template<typename T >
TArrayView< T > UE::MovieScene::TComponentPtr< T >::Slice ( int32  StartIndex,
int32  Num 
) const
inline

Retrieve a slice of this component data as an array view of the specified size and offset (usually the size will be FEntityAllocation::Num())

Member Data Documentation

◆ ComponentPtr

template<typename T >
T* UE::MovieScene::TComponentPtr< T >::ComponentPtr
protected

The documentation for this struct was generated from the following file: