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 > API/Runtime/Chaos/GeometryCollection > API/Runtime/Chaos/GeometryCollection/Facades

References

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

Syntax

class FCollectionTransformFacade

Remarks

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

Constructors

  Type Name Description
Public function    
Public function    

Functions

  Type Name Description
Public function Const FString

BoneName ( int32 Index
)

 Get a bone name from the index if the facade has the attribute defined.
Public function 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
Public function 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
Public function Const FTransform Returns the transform for transforming from bone space to collection space for specified bone Vertex(inCollectionSpace) = TransformComputed.TransformPosition(Vertex(inBoneSpace))
Public function Const TArray< FTransform > Returns array of transforms for transforming from bone space to collection space Vertex(inCollectionSpace) = TransformComputed.TransformPosition(Vertex(inBoneSpace))
Public function void Creates the facade attributes.
Public function void

EnforceSingleRoot ( const FString& RootName
)

 Adds a Identity transform and nests all roots under the new transform
Public function Const const TManagedArray< FString > * Returns the bone names from the collection. Null if not initialized.
Public function Const const TManagedArray< TSet< int32 > > * Returns the child indicesfrom the collection. Null if not initialized.
Public function Const const TManagedArray< FTransform3f > * Returns the child indicesfrom the collection. Null if not initialized.
Public function Const const TManagedArray< int32 > * Returns the parent indices from the collection. Null if not initialized.
Public function Const TArray< int32 > Gets the root index
Public function Const bool Check if the facade has the bone name attribute.
Public function Static bool

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

 Does the transform heirarchy have a cycle
Public function Static bool

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

 Does the transform heirarchy have a cycle
Public function Const bool

IsConst ()

 Is the facade defined constant.
Public function Const bool

IsValid ()

 Valid if parent and children arrays are available
Public function Const int32

Num ()

 Get the number of transforms
Public function void

ParentTransform ( const int32 TransformIndex,
const int32 ChildIndex
)

 Parent a single transform
Public function void

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

 Parent the list of transforms to the selected index.
Public function void Sets the selected bone's transform to identity
Public function void

SetPivot ( const FTransform& InTransform
)

 Transforms the pivot of a collection
Public function void

Transform ( const FTransform& InTransform
)

 Transforms collection
Public function void

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

 Transforms selected bones in the collection
Public function void

UnparentTransform ( const int32 ChildIndex
)

 Unparent the child index from its parent

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page