1. Epic GamesDeveloper
  3. FTraitPtr

FTraitPtr

Trait Pointer A trait pointer represents a shared pointer to allocated instance data.

API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/TraitCore

References

   
Module AnimNext
Header /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/TraitCore/TraitPtr.h
Include #include "TraitCore/TraitPtr.h"

Syntax

struct FTraitPtr

Remarks

Trait Pointer A trait pointer represents a shared pointer to allocated instance data. It manages reference counting. It points to a FTraitInstanceData or FNodeInstance when resolved.

A node pointer can also be weak, meaning that it does not update reference counting. Note that weak pointers will point to garbage if the trait instance is destroyed.

Weak trait pointers should be used carefully!

Constructors

  Type Name Description
Public function constexpr Constructs an invalid pointer handle.
Public function  

FTraitPtr ( const FTraitPtr& TraitPtr
)

  
Public function  

FTraitPtr ( const FWeakTraitPtr& TraitPtr
)

  
Public function  

FTraitPtr ( FTraitPtr&& TraitPtr
)

  
Public function  

FTraitPtr ( FNodeInstance* InNodeInstance,
uint32 InTraitIndex
)

 Constructs a pointer handle to the provided instance.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const FNodeInstance * Returns a pointer to the node instance.
Public function Const uint32 Returns the trait index this pointer handle references.
Public function Const bool

IsValid ()

 Returns true when the pointer is valid, false otherwise.
Public function Const bool

IsWeak ()

 Returns true if this pointer handle is weak, false otherwise.
Public function void

Reset ()

 Clears the handle and renders it invalid.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FTraitPtr& RHS
)

  
Public function Const bool

operator!= ( const FWeakTraitPtr& RHS
)

  
Public function FTraitPtr &

operator= ( const FWeakTraitPtr& TraitPtr
)

  
Public function FTraitPtr &

operator= ( const FTraitPtr& TraitPtr
)

  
Public function FTraitPtr &

operator= ( FTraitPtr&& TraitPtr
)

  
Public function Const bool

operator== ( const FTraitPtr& RHS
)

 Equality and inequality tests.
Public function Const bool

operator== ( const FWeakTraitPtr& RHS
)

  

Enums

  Type Name Description
Private enum EFlags Various flags stored in the pointer alignment bits, assumes an alignment of at least 4 bytes.  

See Also

FNodeInstance

FTraitInstanceData

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page