1. Epic GamesDeveloper
  3. FDataRegistry

FDataRegistry

Global registry of animation data Holds ref counted data that gets released when the last DataHandle of that element goes out of scope Calling public functions from multiple threads is expected.

API > API/Plugins > API/Plugins/AnimNext

References

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

Syntax

class FDataRegistry

Remarks

Global registry of animation data Holds ref counted data that gets released when the last DataHandle of that element goes out of scope Calling public functions from multiple threads is expected. Data races are guarded by a FRWLock. TODO : Memory management will have to be implemented to avoid fragmentation and performance reasons

Functions

  Type Name Description
Public function FDataHandle

AllocateData ( const int32 NumElements,
ArgTypes&&... Args
)

 Allocates memory for a type, initialized with the default constructor (with optional passed arguments) Returns a refcounted animation data handle Allocated memory will be released once the refcount reaches 0
Public function Static FDataRegistry *

Get ()

 Access the global registry.
Public function FDataHandle

GetOrGenerateReferencePose ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Returns a ref counted handle to the refence pose of the given skeletal mesh component.
Public function Const FDataHandle

GetRegisteredData ( const FName& Id
)

 Obtains the data hanle for the passed Id, if it exists.
Public function FDataHandle

PreAllocateMemory ( const int32 NumElements
)

 Allocates uninitialized memory for a type (leaving the initialization to the caller) Returns a refcounted animation data handle Allocated memory will be released once the refcount reaches 0
Public function void

RegisterData ( const FName& Id,
const FDataHandle& AnimationDataHandle
)

 Registers an anim data handle with arbitrary data using an FName Note that AnimDataHandles are refcounted, so this makes them permanent until unregistered
Public function void

RegisterDataType ( int32 AllocationBlockSize
)

 Registers a type and sets the desired preallocation block size If a type is allocated without registering, a default block size of 32 will be used
Public function FDataHandle

RegisterReferencePose ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Generates and registers a reference pose for the SkeletalMesh asset of the SkeletalMeshComponent and modifies it with the additional required bones or the visibility state of the bones of the SkeletalMeshComponent
Public function void

RemoveReferencePose ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Removes a previously registered reference pose for the given SkeletalMeshComponent.
Public function void

UnregisterData ( const FName& Id
)

 Unregisters a previously registered anim data handle.

Typedefs

Name Description
DestroyFnSignature  

Constants

Name Description
DEFAULT_BLOCK_SIZE  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page