1. Epic GamesDeveloper
  3. FBoneHierarchy

FBoneHierarchy

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

Unreal Engine C++ API Reference > Runtime > Chaos

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/BoneHierarchy.h
Include #include "BoneHierarchy.h"

Syntax

class FBoneHierarchy

Remarks

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

Variables

  Type Name Description
Protected variable FTransform ActorLocalToWorld The current top level local-to-world transform.
Protected variable bool ActorLocalToWorldDirty  
Protected variable TArray< uint8 > AnimDirty Dirty flags for each bone in the hierarchy, plus sub group structures.
Protected variable TArray< int32 > BoneIndices  
Protected variable TMap< int32, FAnalyticImplicitGroup * > BoneToShapeGroup A mapping from Bone index to implicit shape group.
Protected variable TMap< int32, int32 > BoneToTransformIndex Mapping from Bone index to our local transform array indices.
Protected variable TArray< TArray< int32 > > ChildIndices  
Protected variable TArray< TUniquePtr< FAnalyticImplicitGroup > > ImplicitGroups Owner of all implicit shape groups.
Protected variable TArray< FTransform > LocalSpaceTransforms Local, component, and world space transforms of each bone in the hierarchy, plus sub group structures.
Protected variable TArray< int32 > ParentIndices Parenting hierarchy for each bone and sub group structure.
Protected variable TArray< FTransform > PrevWorldSpaceTransforms  
Protected variable TArray< FAnalyticImplicitGroup * > Roots All implicit groups in the hierarchy that have no parents.
Protected variable TArray< int32 > SocketIndices  
Protected variable TArray< int32 > TempTargetIndices The working set of indices.
Protected variable TMap< int32, int32 > TransformToBoneIndex  
Protected variable TArray< FTransform > WorldSpaceTransforms TArray ComponentSpaceTransforms;.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function void

Add ( TUniquePtr< FAnalyticImplicitGroup >&& AnalyticShapeGroupIn
)

 Add a structure to the hierarchy.
Public function Const const FAnalyticImplicitGroup *

GetAnalyticShapeGroup ( const int32 BoneIndex
)

  
Public function FAnalyticImplicitGroup *

GetAnalyticShapeGroup ( const int32 BoneIndex
)

  
Public function TArray< TUniquePtr< FAnalyticImplicitGroup > > &  
Public function Const const TArray< TUniquePtr< FAnalyticImplicitGroup > > &  
Protected function Const bool

GetAnimLocalDirty ( const int32 TransformIndex
)

  
Public function Const const FTransform *

GetAnimWorldSpaceTransformsForBone ( const int32 BoneIndex
)

 Get all world space transforms associated with `BoneIndex_.
Public function Const const TArray< int32 > &  
Protected function void

GetDirtyAnimIndices ( TArray< int32 >& TargetIndices
)

  
Protected function Const void

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

 Get a list of all transform indices that are dirty.
Public function Const const FTransform *

GetPrevAnimWorldSpaceTransformForBone ( const int32 BoneIndex
)

  
Public function Const int32

GetSocketIndexForBone ( const uint32 BoneIndex
)

  
Public function Const int32

GetTransformIndex ( const int32 BoneIndex
)

  
Public function Const bool

HasBoneIndex ( const uint32 BoneIndex
)

  
Protected function void Update each implicit group with parent and child information, and find root nodes.
Public function void Build the hierarchy. Must be done after adding structures, and before updating or sampling.
Public function void

InitPreAdd ( const int32 NumBones
)

 Initialization.
Public function bool Update all world space transforms for sampling.
Public function void  
Protected function void Propagate bone space dirty flags from parents to sub structures and children.
Public function void

SetActorWorldSpaceTransform ( const FTransform& InActorLocalToWorld
)

 Update the local-to-world transform of the actor the bones this hierarchy represents belongs to.
Protected function void

SetAnimLocalClean ( const int32 TransformIndex
)

  
Protected function void

SetAnimLocalDirty ( const int32 TransformIndex
)

  
Public function void

SetAnimLocalSpaceTransform ( const int32 BoneIndex,
const FTransform& BoneXf
)

 Updates the local/bone space transform of a bone.
Public function void

SetSocketIndexForBone ( const uint32 BoneIndex,
const int32 SocketIndex
)

  
Protected function bool

UpdateAnimWorldSpaceTransforms ( const TArray< int32 >& TargetIndices
)

 Update the component space transforms of the specified indices.

Operators

  Type Name Description
Public function FBoneHierarchy &  
Public function FBoneHierarchy &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page