1. Epic GamesDeveloper
  3. FGeometryCollectionClusteringUtility

FGeometryCollectionClusteringUtility

Unreal Engine C++ API Reference > Runtime > Chaos > GeometryCollection

References

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

Syntax

class FGeometryCollectionClusteringUtility

Functions

  Type Name Description
Public function Static void Cluster all existing bones under a new root node, so there is now only one root node and a completely flat hierarchy underneath it
Public function Static void

ClusterBonesByContext ( FGeometryCollection* GeometryCollection,
int32 MergeNode,
const TArray< int32 >& SourceElementsIn
)

 Clusters using one of ClusterBonesUnderNewNode or ClusterBonesUnderExistingNode based on the context of what is being clustered
Public function Static void

ClusterBonesUnderExistingNode ( FGeometryCollection* GeometryCollection,
int32 MergeNode,
const TArray< int32 >& SourceElements
)

 Cluster all source bones under an existing node, existing node is specifiedas MergeNode
Public function Static void

ClusterBonesUnderExistingNode ( FGeometryCollection* GeometryCollection,
const TArray< int32 >& SourceElements
)

 Cluster all source bones under an existing node, algorithm chooses best node to add to 'closest to root'
Public function Static void

ClusterBonesUnderExistingRoot ( FGeometryCollection* GeometryCollection,
const TArray< int32 >& SourceElements
)

 Reparent source bones under root bone
Public function Static int32

ClusterBonesUnderNewNode ( FGeometryCollection* GeometryCollection,
const int32 InsertAtIndex,
const TArray< int32 >& SelectedBones,
bool CalcNewLocalTransform,
bool Validate
)

 Creates a cluster in the node hierarchy by re-parenting the Selected Bones off a new node in the hierarchy It makes more sense to think that the Selected Bones are all at the same level in the hierarchy however it will re-parent multiple levels at the InsertAtIndex location bone
Public function Static int32

ClusterBonesUnderNewNodeWithParent ( FGeometryCollection* GeometryCollection,
const int32 ParentOfNewNode,
const TArray< int32 >& SelectedBones,
bool CalcNewLocalTransform,
bool Validate
)

 Same as ClusterBonesUnderNewNode, but specify the parent of the new node instead of a sibling.
Public function Static void

CollapseHierarchyOneLevel ( FGeometryCollection* GeometryCollection,
TArray< int32 >& SourceElements
)

 Moved the selected bones closer to the root
Public function Static void

CollapseLevelHierarchy ( int8 Level,
FGeometryCollection* GeometryCollection
)

 Collapse hierarchy at specified level
Public function Static void

CollapseSelectedHierarchy ( int8 Level,
const TArray< int32 >& SelectedBones,
FGeometryCollection* GeometryCollection
)

 Collapse hierarchy of selected bones at specified level
Public function Static bool Returns true if bone hierarchy contains more than one root node
Public function Static int32

FindLowestCommonAncestor ( const FManagedArrayCollection* GeometryCollection,
const TArray< int32 >& SelectedBones
)

 Find the lowest common ancestor index of currently selected nodes.
Public function Static void

GetBonesToLevel ( const FGeometryCollection* GeometryCollection,
int32 Level,
TArray< int32 >& BonesOut,
bool bOnlyClusteredOrRigid,
bool bSkipFiltered
)

 Get list of all bones above the specified hierarchy level
Public function Static void

GetChildBonesAtLevel ( const FGeometryCollection* GeometryCollection,
int32 SourceBone,
int32 Level,
TArray< int32 >& BonesOut
)

 Get list of child bones down from the source bone at the specified hierarchy level
Public function Static void

GetChildBonesFromLevel ( const FGeometryCollection* GeometryCollection,
int32 SourceBone,
int32 Level,
TArray< int32 >& BonesOut
)

 Get list of child bones down from the source bone below the specified hierarchy level
Public function Static void

GetClusteredBonesWithCommonParent ( const FGeometryCollection* GeometryCollection,
int32 SourceBone,
TArray< int32 >& BonesOut
)

 Finds all Bones in same cluster as the one specified
Public function Static void

GetLeafBones ( const FManagedArrayCollection* GeometryCollection,
int BoneIndex,
bool bOnlyRigids,
TArray< int32 >& LeafBonesOut
)

 Return an array of all child leaf nodes below the specified node.
Public function Static int32

GetParentOfBoneAtSpecifiedLevel ( const FGeometryCollection* GeometryCollection,
int32 SourceBone,
int32 Level,
bool bSkipFiltered
)

 Search hierarchy for the parent of the specified bone, where the parent exists at the given level in the hierarchy.
Public function Static void

GetRootBones ( const FGeometryCollection* GeometryCollection,
TArray< int32 >& RootBonesOut
)

 Finds the root bone in the hierarchy, the one with an invalid parent bone index
Public function Static bool

IsARootBone ( const FGeometryCollection* GeometryCollection,
int32 InBone
)

 Return true if the specified bone is a root bone
Public function Static void

MoveUpOneHierarchyLevel ( FGeometryCollection* GeometryCollection,
const TArray< int32 >& SelectedBones
)

 Move the selected node up a level in direction of root
Public function Static bool

NodeExistsOnThisBranch ( const FGeometryCollection* GeometryCollection,
int32 TestNode,
int32 TreeElement
)

 Return true of Test Node exists on tree branch specified by TreeElement Node
Public function Static int32

PickBestNodeToMergeTo ( const FManagedArrayCollection* Collection,
const TArray< int32 >& SourceElements
)

  
Public function Static void

RecursiveAddAllChildren ( const TManagedArray< TSet< int32 >>& Children,
int32 SourceBone,
TArray< int32 >& BonesOut
)

 Recursively Add all children to output bone list from source bone down to the leaf nodes
Public function Static void

RecursivelyUpdateChildBoneNames ( int32 BoneIndex,
const TManagedArray< TSet< int32 >>& Children,
TManagedArray< FString >& BoneNames,
bool OverrideBoneNames
)

 Maintains the bone naming convention of Root "Name" Level 1 "Name_001", "Name_0002", ...
Public function Static bool Simplify the geometry collection by removing cluster nodes w/ a parent and only one child, re-parenting the child to its grand-parent.
Public function Static bool Delete any cluster nodes discovered to have no children. Returns true if any nodes were removed.
Public function Static void

RenameBone ( FGeometryCollection* GeometryCollection,
int32 BoneIndex,
const FString& NewName,
bool UpdateChildren
)

 Rename a bone node, will automatically update all child node names if requested (current default)
Public function Static void

UpdateHierarchyLevelOfChildren ( FGeometryCollection* GeometryCollection,
int32 ParentElement
)

 Recursively update the hierarchy level of all the children below this bone
Public function Static void

UpdateHierarchyLevelOfChildren ( FManagedArrayCollection& InCollection,
int32 ParentElement
)

 Recursively update the hierarchy level of all the children below this bone
Public function Static void

ValidateResults ( FGeometryCollection* GeometryCollection
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page