FBoneHierarchy

API > API/Runtime > API/Runtime/Chaos

A hierarchy of transforms (bones) that tracks the state of transforms within the hierarchy, to do partial updates.

   
Name FBoneHierarchy
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/BoneHierarchy.h
Include Path #include "BoneHierarchy.h"

Syntax

class FBoneHierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  BoneHierarchy.h  
  BoneHierarchy.h  
  BoneHierarchy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( TUniquePtr< FAnalyticImplicitGroup >&& AnalyticShapeGroupIn
)

 Add a structure to the hierarchy. BoneHierarchy.h  

const FAnalyticImplicitGroup * GetAnalyticShapeGroup ( const int32 BoneIndex
) const

   BoneHierarchy.h  

FAnalyticImplicitGroup * GetAnalyticShapeGroup ( const int32 BoneIndex
)

   BoneHierarchy.h  
  BoneHierarchy.h  
  BoneHierarchy.h  

const FTransform * GetAnimWorldSpaceTransformsForBone ( const int32 BoneIndex
) const

 Get all world space transforms associated with `BoneIndex_. BoneHierarchy.h  

const TArray< int32 > & GetBoneIndices()

   BoneHierarchy.h  

const FTransform * GetPrevAnimWorldSpaceTransformForBone ( const int32 BoneIndex
) const

   BoneHierarchy.h  

int32 GetSocketIndexForBone ( const uint32 BoneIndex
) const

   BoneHierarchy.h  

int32 GetTransformIndex ( const int32 BoneIndex
) const

   BoneHierarchy.h  

bool HasBoneIndex ( const uint32 BoneIndex
) const

   BoneHierarchy.h  

void InitPostAdd()

 Build the hierarchy. Must be done after adding structures, and before updating or sampling. BoneHierarchy.h  

void InitPreAdd ( const int32 NumBones
)

 Initialization. BoneHierarchy.h  

bool PrepareAnimWorldSpaceTransforms()

 Update all world space transforms for sampling. BoneHierarchy.h  

void PrepareForUpdate()

   BoneHierarchy.h  

void SetActorWorldSpaceTransform ( const FTransform& InActorLocalToWorld
)

 Update the local-to-world transform of the actor the bones this hierarchy represents belongs to. BoneHierarchy.h  

void SetAnimLocalSpaceTransform ( const int32 BoneIndex,
const FTransform& BoneXf
)

 Updates the local/bone space transform of a bone. BoneHierarchy.h  

void SetSocketIndexForBone ( const uint32 BoneIndex,
const int32 SocketIndex
)

   BoneHierarchy.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool GetAnimLocalDirty ( const int32 TransformIndex
) const

   BoneHierarchy.h  

void GetDirtyAnimIndices ( TArray< int32 >& TargetIndices
)

   BoneHierarchy.h  

void GetDirtyIndices ( TArray< int32 >& TargetIndices,
const uint8 Mask
) const

 Get a list of all transform indices that are dirty. BoneHierarchy.h  

void InitHierarchy ()

 Update each implicit group with parent and child information, and find root nodes. BoneHierarchy.h  

void PropagateAnimDirtyFlags()

 Propagate bone space dirty flags from parents to sub structures and children. BoneHierarchy.h  

void SetAnimLocalClean ( const int32 TransformIndex
)

   BoneHierarchy.h  

void SetAnimLocalDirty ( const int32 TransformIndex
)

   BoneHierarchy.h  

bool UpdateAnimWorldSpaceTransforms ( const TArray< int32 >& TargetIndices
)

 Update the component space transforms of the specified indices. BoneHierarchy.h  

Operators

Name Remarks Include Path Unreal Specifiers
  BoneHierarchy.h  
  BoneHierarchy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page