Navigation
API > API/Plugins > API/Plugins/MetasoundFrontend
Inheritance Hierarchy
- TAccessPtr
- FClassAccessPtr
- FConstClassAccessPtr
- FConstDocumentAccessPtr
- FConstGraphClassAccessPtr
- FConstNodeAccessPtr
- FDocumentAccessPtr
- FGraphClassAccessPtr
- FNodeAccessPtr
References
| Module | MetasoundFrontend |
| Header | /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundAccessPtr.h |
| Include | #include "MetasoundAccessPtr.h" |
Syntax
template<typename Type>
class TAccessPtr
Remarks
TAccessPtr is used to determine whether an object has been destructed or not. It is useful when an object cannot be wrapped in a TSharedPtr. A TAccessPtr is functionally similar to a TWeakPtr, but it cannot pin the object. In order to determine whether an object as accessible, the TAccessPtr executes a TFunctions<> which returns object. If a nullptr is returned, then the object is not accessible.
Object pointers held within a TAccessPtr must only be accessed on the thread where the objects gets destructed to avoid having the object destructed while in use.
If the TAccessPtr's underlying object is accessed when the pointer is invalid, a fallback object will be returned.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
Type * | CachedObjectPtr | |
 |
TFunction< Type *()> | GetObject |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
TAccessPtr () |
||
 |
TAccessPtr
(
const TAccessPtr< Type >& InOther |
||
 |
TAccessPtr
(
TAccessPtr< Type >&& InOther |
||
 |
TAccessPtr
(
TFunction< Type*()> InGetObject |
||
 |
TAccessPtr
(
TWeakPtr< FTokenType > AccessToken, |
Creates a access pointer using an access token. | |
 |
TAccessPtr
(
const TAccessPtr< OtherType >& InOther, |
Creates an access pointer from another using a const casts. | |
 |
TAccessPtr
(
const TAccessPtr< OtherType >& InOther, |
Creates an access pointer from another using a static cast. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
Type * | Get () |
Returns a pointer to the accessible object. If the object is inaccessible, a nullptr is returned. |
  |
AccessPtrType | GetMemberAccessPtr
(
FunctionType InGetMember |
Returns an access pointer to a member of the wrapped object. |
Operators
| Type | Name | Description | |
|---|---|---|---|
 |
TAccessPtr< Type > & | operator=
(
const TAccessPtr< Type >& InOther |
|
 |
TAccessPtr & | operator=
(
TAccessPtr< Type >&& InOther |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
EConstCast | ||
 |
EDerivedCopy |
Typedefs
| Name | Description |
|---|---|
| FTokenType | |
| ObjectType |
Constants
| Name | Description |
|---|---|
| FallbackObject |