GeometryCollection::Facades::FCollectionTransformFacade Class Reference

#include <CollectionTransformFacade.h>

Public Member Functions
CHAOS_API	FCollectionTransformFacade (FManagedArrayCollection &InCollection)
CHAOS_API	FCollectionTransformFacade (const FManagedArrayCollection &InCollection)
void	DefineSchema ()
CHAOS_API bool	IsValid () const
bool	IsConst () const
CHAOS_API int32	Num () const
CHAOS_API TArray< int32 >	GetRootIndices () const
CHAOS_API FTransform	GetRootTransform () const
const TManagedArray< int32 > *	GetParents () const
const TManagedArray< TSet< int32 > > *	FindChildren () const
const TManagedArray< FTransform3f > *	FindTransforms () const
const TManagedArray< FString > *	FindBoneNames () const
CHAOS_API TArray< FTransform >	ComputeCollectionSpaceTransforms () const
CHAOS_API FTransform	ComputeCollectionSpaceTransform (int32 BoneIdx) const
CHAOS_API void	SetPivot (const FTransform &InTransform)
CHAOS_API void	Transform (const FTransform &InTransform)
CHAOS_API void	Transform (const FTransform &InTransform, const TArray< int32 > &InSelection)
CHAOS_API bool	HasBoneNameAttribute () const
CHAOS_API FString	BoneName (int32 Index) const
CHAOS_API TMap< FString, int32 >	BoneNameIndexMap () const
CHAOS_API void	SetBoneTransformToIdentity (int32 BoneIdx)
CHAOS_API void	ParentTransform (const int32 TransformIndex, const int32 ChildIndex)
CHAOS_API void	ParentTransforms (const int32 TransformIndex, const TArray< int32 > &SelectedBones)
CHAOS_API void	UnparentTransform (const int32 ChildIndex)
CHAOS_API void	EnforceSingleRoot (const FString &RootName)
CHAOS_API void	ComputeLevelsBounds (float &LevelsMin, float &LevelsMax)

Static Public Member Functions
static CHAOS_API 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)
static CHAOS_API 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)
static CHAOS_API bool	HasCycle (const TManagedArray< int32 > &Parents, int32 Node)
static CHAOS_API bool	HasCycle (const TManagedArray< int32 > &Parents, const TArray< int32 > &SelectedBones)

Detailed Description

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

Constructor & Destructor Documentation

FCollectionTransformFacade() [1/2]

GeometryCollection::Facades::FCollectionTransformFacade::FCollectionTransformFacade

(

FManagedArrayCollection &

InCollection

)

FCollectionTransformFacade() [2/2]

GeometryCollection::Facades::FCollectionTransformFacade::FCollectionTransformFacade

(

const FManagedArrayCollection &

InCollection

)

Member Function Documentation

BoneName()

FString GeometryCollection::Facades::FCollectionTransformFacade::BoneName

(

int32

Index

)

const

Get a bone name from the index if the facade has the attribute defined.

BoneNameIndexMap()

TMap< FString, int32 > GeometryCollection::Facades::FCollectionTransformFacade::BoneNameIndexMap

(

)

const

Get a TMap from bone name to bone index if the facade has the attribute defined.

BuildMatrix()

FMatrix GeometryCollection::Facades::FCollectionTransformFacade::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  )

static

Builds a FMatrix from all the components

BuildTransform()

FTransform GeometryCollection::Facades::FCollectionTransformFacade::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  )

static

Builds a FTransform from all the components

ComputeCollectionSpaceTransform()

FTransform GeometryCollection::Facades::FCollectionTransformFacade::ComputeCollectionSpaceTransform

(

int32

BoneIdx

)

const

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

ComputeCollectionSpaceTransforms()

TArray< FTransform > GeometryCollection::Facades::FCollectionTransformFacade::ComputeCollectionSpaceTransforms

(

)

const

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

ComputeLevelsBounds()

void GeometryCollection::Facades::FCollectionTransformFacade::ComputeLevelsBounds	(	float &	LevelsMin,
		float &	LevelsMax
	)

Computes the Min/Max values of the Level attribute

DefineSchema()

void GeometryCollection::Facades::FCollectionTransformFacade::DefineSchema ( )

inline

Creates the facade attributes.

EnforceSingleRoot()

CHAOS_API void GeometryCollection::Facades::FCollectionTransformFacade::EnforceSingleRoot

(

const FString &

RootName

)

Adds a Identity transform and nests all roots under the new transform

FindBoneNames()

const TManagedArray< FString > * GeometryCollection::Facades::FCollectionTransformFacade::FindBoneNames ( ) const

inline

Returns the bone names from the collection. Null if not initialized.

FindChildren()

const TManagedArray< TSet< int32 > > * GeometryCollection::Facades::FCollectionTransformFacade::FindChildren ( ) const

inline

Returns the child indicesfrom the collection. Null if not initialized.

FindTransforms()

const TManagedArray< FTransform3f > * GeometryCollection::Facades::FCollectionTransformFacade::FindTransforms ( ) const

inline

Returns the child indicesfrom the collection. Null if not initialized.

GetParents()

const TManagedArray< int32 > * GeometryCollection::Facades::FCollectionTransformFacade::GetParents ( ) const

inline

Returns the parent indices from the collection. Null if not initialized.

GetRootIndices()

TArray< int32 > GeometryCollection::Facades::FCollectionTransformFacade::GetRootIndices

(

)

const

Gets the root index

GetRootTransform()

FTransform GeometryCollection::Facades::FCollectionTransformFacade::GetRootTransform

(

)

const

Gets the main root transform

HasBoneNameAttribute()

bool GeometryCollection::Facades::FCollectionTransformFacade::HasBoneNameAttribute

(

)

const

Check if the facade has the bone name attribute.

HasCycle() [1/2]

bool GeometryCollection::Facades::FCollectionTransformFacade::HasCycle ( const TManagedArray< int32 > &  Parents, const TArray< int32 > &  SelectedBones  )

static

Does the transform heirarchy have a cycle

HasCycle() [2/2]

bool GeometryCollection::Facades::FCollectionTransformFacade::HasCycle ( const TManagedArray< int32 > &  Parents, int32  Node  )

static

Does the transform heirarchy have a cycle

IsConst()

bool GeometryCollection::Facades::FCollectionTransformFacade::IsConst ( ) const

inline

Is the facade defined constant.

IsValid()

bool GeometryCollection::Facades::FCollectionTransformFacade::IsValid

(

)

const

Valid if parent and children arrays are available

Num()

int32 GeometryCollection::Facades::FCollectionTransformFacade::Num

(

)

const

Get the number of transforms

ParentTransform()

void GeometryCollection::Facades::FCollectionTransformFacade::ParentTransform	(	const int32	TransformIndex,
		const int32	ChildIndex
	)

Parent a single transform

ParentTransforms()

void GeometryCollection::Facades::FCollectionTransformFacade::ParentTransforms	(	const int32	TransformIndex,
		const TArray< int32 > &	SelectedBones
	)

Parent the list of transforms to the selected index.

SetBoneTransformToIdentity()

void GeometryCollection::Facades::FCollectionTransformFacade::SetBoneTransformToIdentity

(

int32

BoneIdx

)

Sets the selected bone's transform to identity

SetPivot()

void GeometryCollection::Facades::FCollectionTransformFacade::SetPivot

(

const FTransform &

InTransform

)

Transforms the pivot of a collection

Transform() [1/2]

void GeometryCollection::Facades::FCollectionTransformFacade::Transform

(

const FTransform &

InTransform

)

Transforms collection

Transform() [2/2]

void GeometryCollection::Facades::FCollectionTransformFacade::Transform	(	const FTransform &	InTransform,
		const TArray< int32 > &	InSelection
	)

Transforms selected bones in the collection

UnparentTransform()

void GeometryCollection::Facades::FCollectionTransformFacade::UnparentTransform

(

const int32

ChildIndex

)

Unparent the child index from its parent

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/Facades/CollectionTransformFacade.h
• Engine/Source/Runtime/Experimental/Chaos/Private/GeometryCollection/Facades/CollectionTransformFacade.cpp