GeometryCollection::Facades::FTransformSource Class Reference

#include <CollectionTransformSourceFacade.h>

Public Member Functions
CHAOS_API	FTransformSource (FManagedArrayCollection &InSelf)
CHAOS_API	FTransformSource (const FManagedArrayCollection &InSelf)
CHAOS_API void	DefineSchema ()
bool	IsConst () const
CHAOS_API bool	IsValid () const
CHAOS_API void	AddTransformSource (const FString &Name, const FString &Guid, const TSet< int32 > &Roots, const FString &SKMName=FString())
CHAOS_API TSet< int32 >	GetTransformSource (const FString &Name, const FString &Guid, const FString &SKMName=FString()) const

Static Public Attributes
static CHAOS_API const FName	TransformSourceGroupName = "TransformSource"
static CHAOS_API const FName	SourceNameAttributeName = "Name"
static CHAOS_API const FName	SourceGuidAttributeName = "GuidID"
static CHAOS_API const FName	SourceRootsAttributeName = "Roots"
static CHAOS_API const FName	SourceSkeletalMeshNameAttributeName = "SkeletalMeshName"

Detailed Description

FTransformSource

Defines common API for storing owners of a transform hierarchy. For example, to store the component that generated a transform hierirchy, use the function : Key = this->AddTransformSource(<Skeleton Asset Name>, <Skeleton Asset Guid>, {<Root transform indices in collection>});

Key = this->AddTransformSource("", GUID, {1,5,7});

The source root indices can be queries later using the name and guid: TSet<int32> SourceRoots = this->GetSourceTransformRoots("", GUID);

The following groups are created on the collection based on which API is called.

<Group> = FTransformSource::TransformSourceGroup

• FindAttribute<FString>(FTransformSource::SourceNameAttribute, <Group>);
• FindAttribute<Guid>(FTransformSource::SourceGuidAttribute, <Group>);
• FindAttribute<TSet<int32>>(FTransformSource::SourceRootsAttribute, <Group>);

Constructor & Destructor Documentation

FTransformSource() [1/2]

GeometryCollection::Facades::FTransformSource::FTransformSource

(

FManagedArrayCollection &

InSelf

)

FSelectionFacade Constuctor

Parameters

VertixDependencyGroup

: GroupName the index attribute is dependent on.

FTransformSource() [2/2]

GeometryCollection::Facades::FTransformSource::FTransformSource

(

const FManagedArrayCollection &

InSelf

)

Member Function Documentation

AddTransformSource()

void GeometryCollection::Facades::FTransformSource::AddTransformSource	(	const FString &	Name,
		const FString &	Guid,
		const TSet< int32 > &	Roots,
		const FString &	SKMName = FString()
	)

Add a transform root mapping.

Parameters

Name	: Name of the owner of the transform set.
Guid	: Guid of the owner of the transform set.
Roots	: Root indices of the transform set.
SKMName	: Name of the skeletal mesh owner of the transform set.

DefineSchema()

void GeometryCollection::Facades::FTransformSource::DefineSchema

(

)

Create the facade.

GetTransformSource()

TSet< int32 > GeometryCollection::Facades::FTransformSource::GetTransformSource	(	const FString &	Name,
		const FString &	Guid,
		const FString &	SKMName = FString()
	)		const

Query for root indices.

Parameters

Name	: Name of the owner of the transform set.
Guid	: Guid of the owner of the transform set.

IsConst()

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

inline

Is the facade defined constant.

IsValid()

bool GeometryCollection::Facades::FTransformSource::IsValid

(

)

const

Is the Facade defined on the collection?

Member Data Documentation

SourceGuidAttributeName

const FName GeometryCollection::Facades::FTransformSource::SourceGuidAttributeName = "GuidID"

static

SourceNameAttributeName

const FName GeometryCollection::Facades::FTransformSource::SourceNameAttributeName = "Name"

static

SourceRootsAttributeName

const FName GeometryCollection::Facades::FTransformSource::SourceRootsAttributeName = "Roots"

static

SourceSkeletalMeshNameAttributeName

const FName GeometryCollection::Facades::FTransformSource::SourceSkeletalMeshNameAttributeName = "SkeletalMeshName"

static

TransformSourceGroupName

const FName GeometryCollection::Facades::FTransformSource::TransformSourceGroupName = "TransformSource"

static

---

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

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