1. Epic GamesDeveloper
  3. FCollectionTransformFacade

FCollectionTransformFacade

Provides an API to read and manipulate hierarchy in a managed array collection

API > API/Runtime > API/Runtime/Chaos

Provides an API to read and manipulate hierarchy in a managed array collection

   
Name FCollectionTransformFacade
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/Facades/CollectionTransformFacade.h
Include Path #include "GeometryCollection/Facades/CollectionTransformFacade.h"

Syntax

class FCollectionTransformFacade

Constructors

Name Remarks Include Path Unreal Specifiers
  GeometryCollection/Facades/CollectionTransformFacade.h  
  GeometryCollection/Facades/CollectionTransformFacade.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BoneNameAttribute TManagedArrayAccessor< FString >   GeometryCollection/Facades/CollectionTransformFacade.h  
ChildrenAttribute TManagedArrayAccessor< TSet< int32 > >   GeometryCollection/Facades/CollectionTransformFacade.h  
Collection FManagedArrayCollection *   GeometryCollection/Facades/CollectionTransformFacade.h  
ConstCollection const FManagedArrayCollection &   GeometryCollection/Facades/CollectionTransformFacade.h  
ParentAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionTransformFacade.h  
TransformAttribute TManagedArrayAccessor< FTransform3f >   GeometryCollection/Facades/CollectionTransformFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString BoneName ( int32 Index
) const

 Get a bone name from the index if the facade has the attribute defined. GeometryCollection/Facades/CollectionTransformFacade.h  

TMap< FString, int32 > BoneNameIndexMap()

 Get a TMap from bone name to bone index if the facade has the attribute defined. GeometryCollection/Facades/CollectionTransformFacade.h  

FTransform ComputeCollectionSpaceTransform ( int32 BoneIdx
) const

 Returns the transform for transforming from bone space to collection space for specified bone Vertex(inCollectionSpace) = TransformComputed.TransformPosition(Vertex(inBoneSpace)) GeometryCollection/Facades/CollectionTransformFacade.h  

TArray< FTransform > ComputeCollectionSpaceTransforms()

 Returns array of transforms for transforming from bone space to collection space Vertex(inCollectionSpace) = TransformComputed.TransformPosition(Vertex(inBoneSpace)) GeometryCollection/Facades/CollectionTransformFacade.h  

void ComputeLevelsBounds ( float& LevelsMin,
float& LevelsMax
)

 Computes the Min/Max values of the Level attribute GeometryCollection/Facades/CollectionTransformFacade.h  

void DefineSchema()

 Creates the facade attributes. GeometryCollection/Facades/CollectionTransformFacade.h  

void EnforceSingleRoot ( const FString& RootName
)

 Adds a Identity transform and nests all roots under the new transform GeometryCollection/Facades/CollectionTransformFacade.h  

const TManagedArray< FString > * FindBoneNames()

 Returns the bone names from the collection. Null if not initialized. GeometryCollection/Facades/CollectionTransformFacade.h  

const TManagedArray< TSet< int32 > > * FindChildren()

 Returns the child indicesfrom the collection. Null if not initialized. GeometryCollection/Facades/CollectionTransformFacade.h  

const TManagedArray< FTransform3f > * FindTransforms()

 Returns the child indicesfrom the collection. Null if not initialized. GeometryCollection/Facades/CollectionTransformFacade.h  

const TManagedArray< int32 > * GetParents()

 Returns the parent indices from the collection. Null if not initialized. GeometryCollection/Facades/CollectionTransformFacade.h  

TArray< int32 > GetRootIndices()

 Gets the root index GeometryCollection/Facades/CollectionTransformFacade.h  

FTransform GetRootTransform()

 Gets the main root transform GeometryCollection/Facades/CollectionTransformFacade.h  

bool HasBoneNameAttribute()

 Check if the facade has the bone name attribute. GeometryCollection/Facades/CollectionTransformFacade.h  

bool IsConst()

 Is the facade defined constant. GeometryCollection/Facades/CollectionTransformFacade.h  

bool IsValid()

 Valid if parent and children arrays are available GeometryCollection/Facades/CollectionTransformFacade.h  

int32 Num()

 Get the number of transforms GeometryCollection/Facades/CollectionTransformFacade.h  

void ParentTransform ( const int32 TransformIndex,
const int32 ChildIndex
)

 Parent a single transform GeometryCollection/Facades/CollectionTransformFacade.h  

void ParentTransforms ( const int32 TransformIndex,
const TArray< int32 >& SelectedBones
)

 Parent the list of transforms to the selected index. GeometryCollection/Facades/CollectionTransformFacade.h  

void SetBoneTransformToIdentity ( int32 BoneIdx
)

 Sets the selected bone's transform to identity GeometryCollection/Facades/CollectionTransformFacade.h  

void SetPivot ( const FTransform& InTransform
)

 Transforms the pivot of a collection GeometryCollection/Facades/CollectionTransformFacade.h  

void Transform ( const FTransform& InTransform
)

 Transforms collection GeometryCollection/Facades/CollectionTransformFacade.h  

void Transform ( const FTransform& InTransform,
const TArray< int32 >& InSelection
)

 Transforms selected bones in the collection GeometryCollection/Facades/CollectionTransformFacade.h  

void UnparentTransform ( const int32 ChildIndex
)

 Unparent the child index from its parent GeometryCollection/Facades/CollectionTransformFacade.h  

Static

Name Remarks Include Path Unreal Specifiers

static FMatrix BuildMatrix ( const FVector& Translate,
const uint8 RotationOrder,
const FVector& Rotate,
const FVector& Scale,
const FVector& Shear,
const float UniformScale,
const FVector& RotatePivot,
const FVector& ScalePivot,
const bool InvertTransformation
)

 Builds a FMatrix from all the components GeometryCollection/Facades/CollectionTransformFacade.h  

static FTransform BuildTransform ( const FVector& Translate,
const uint8 RotationOrder,
const FVector& Rotate,
const FVector& Scale,
const float UniformScale,
const FVector& RotatePivot,
const FVector& ScalePivot,
const bool InvertTransformation
)

 Builds a FTransform from all the components GeometryCollection/Facades/CollectionTransformFacade.h  

static bool HasCycle ( const TManagedArray< int32 >& Parents,
int32 Node
)

 Does the transform heirarchy have a cycle GeometryCollection/Facades/CollectionTransformFacade.h  

static bool HasCycle ( const TManagedArray< int32 >& Parents,
const TArray< int32 >& SelectedBones
)

 Does the transform heirarchy have a cycle GeometryCollection/Facades/CollectionTransformFacade.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page