1. Epic GamesDeveloper
  3. TSharedFromThis

TSharedFromThis

Derive your class from [TSharedFromThis](API\Runtime\Core\TSharedFromThis) to enable access to a [TSharedRef](API\Runtime\Core\TSharedRef) directly from an object instance that's already been allocated.

API > API/Runtime > API/Runtime/Core

Derive your class from TSharedFromThis to enable access to a TSharedRef directly from an object instance that's already been allocated. Use the optional Mode template argument for thread-safety.

   
Name TSharedFromThis
Type class
Header File /Engine/Source/Runtime/Core/Public/Templates/SharedPointer.h
Include Path #include "Templates/SharedPointer.h"

Syntax

template<class ObjectType, ESPMode Mode>  
class TSharedFromThis : private UE::Core::Private::FSharedFromThisBase

Inheritance Hierarchy

Derived Classes

TSharedFromThis derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Hidden stub constructor Templates/SharedPointer.h  
Hidden stub copy constructor Templates/SharedPointer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~TSharedFromThis()

 Hidden destructor Templates/SharedPointer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
WeakThis TWeakPtr< ObjectType, Mode > Weak reference to ourselves. Templates/SharedPointer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< ObjectType, Mode > AsShared ()

 Provides a shared reference to this object. Templates/SharedPointer.h  

TSharedRef< ObjectType const, Mode > AsShared ()

 Provides a shared reference to this object (const.) Note that is only valid to call this after a shared reference (or shared pointer) to the object has already been created. Templates/SharedPointer.h  

TSharedRef< SubobjectType, Mode > AsSharedSubobject ( SubobjectType* SubobjectPtr
) const

 Provides a shared reference to a subobject of this object, i.e. points to an object which shares the lifetime and refcount of this object, but isn't derived from TSharedFromThis. Templates/SharedPointer.h  

TWeakPtr< ObjectType, Mode > AsWeak ()

 Provides a weak reference to this object. Templates/SharedPointer.h  

TWeakPtr< ObjectType const, Mode > AsWeak ()

   Templates/SharedPointer.h  

TWeakPtr< SubobjectType, Mode > AsWeakSubobject ( SubobjectType* SubobjectPtr
) const

 Provides a weak pointer to a subobject of this object, i.e. points to an object which shares the lifetime and refcount of this object, but isn't derived from TSharedFromThis. Templates/SharedPointer.h  
Checks whether our referenced instance is valid (ie, whether it's safe to call AsShared). Templates/SharedPointer.h  

void UpdateWeakReferenceInternal ( TSharedPtr< SharedPtrType, SharedPtrMode > const* InSharedPtr,
OtherType* InObject
) const

 INTERNAL USE ONLY Do not call this method. Templates/SharedPointer.h  

void UpdateWeakReferenceInternal ( TSharedRef< SharedRefType, SharedPtrMode > const* InSharedRef,
OtherType* InObject
) const

 INTERNAL USE ONLY Do not call this method. Templates/SharedPointer.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< OtherType, Mode > SharedThis ( OtherType* ThisPtr
)

 Provides access to a shared reference to an object, given the object's 'this' pointer. Templates/SharedPointer.h  

static TSharedRef< OtherType const, Mode > SharedThis ( const OtherType* ThisPtr
)

 Provides access to a shared reference to an object, given the object's 'this' pointer. Templates/SharedPointer.h  

Operators

Name Remarks Include Path Unreal Specifiers

TSharedFromThis & operator= ( TSharedFromThis const&
)

 Hidden stub assignment operator Templates/SharedPointer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page