GeometryCollection::Facades::FSelectionFacade Class Reference

#include <CollectionSelectionFacade.h>

Classes
struct	FSelectionKey

Public Member Functions
CHAOS_API	FSelectionFacade (FManagedArrayCollection &InSelf)
CHAOS_API	FSelectionFacade (const FManagedArrayCollection &InSelf)
bool	IsConst () const
CHAOS_API FSelectionKey	AddSelection (const TArray< int32 > &Indices, FName DependencyGroup)
CHAOS_API FSelectionKey	AddSelection (const TArray< int32 > &Indices, const TArray< float > &Weights, FName DependencyGroup)
CHAOS_API FSelectionKey	AddSelection (const int32 BoneIndex, const TArray< int32 > &Indices, FName DependencyGroup, FName BoneDependencyGroup=FName(""))
CHAOS_API FSelectionKey	AddSelection (const int32 BoneIndex, const TArray< int32 > &Indices, const TArray< float > &Weights, FName DependencyGroup, FName BoneDependencyGroup=FName(""))
CHAOS_API void	GetSelection (const FSelectionKey &Key, TArray< int32 > &Indices) const
CHAOS_API void	GetSelection (const FSelectionKey &Key, TArray< int32 > &Indices, TArray< float > &Weights) const
CHAOS_API void	GetSelection (const FSelectionKey &Key, int32 &BoneIndex, TArray< int32 > &Indices) const
CHAOS_API void	GetSelection (const FSelectionKey &Key, int32 &BoneIndex, TArray< int32 > &Indices, TArray< float > &Weights) const

Static Public Attributes
static CHAOS_API const FName	UnboundGroup = "Unbound"
static CHAOS_API const FName	WeightedUnboundGroup = "WeightedUnbound"
static CHAOS_API const FName	BoundGroup = "Bound"
static CHAOS_API const FName	WeightedBoundGroup = "WeightedBound"
static CHAOS_API const FName	IndexAttribute = "Index"
static CHAOS_API const FName	WeightAttribute = "Weights"
static CHAOS_API const FName	BoneIndexAttribute = "BoneIndex"

Detailed Description

FSelectionFacade

Defines common API for storing a sib indexing of a separate group. For example, to store a subset of vertices defined in the group "VerticesGroup", use the function : Key = this->AddSelection({1,2,3,4}); The key can be saved and later used to query the values: TArray<int32> SavedVertices; this->GetSelection(Key, SavedVertices);

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

<Group> = FSelectionFacade::UnboundGroup_<DependencyGroup>

• FindAttribute<TArray<int32>>(FVertexSetInterface::IndexAttribute, <Group>);

<Group> = FSelectionFacade::WeightedUnboundGroup_<DependencyGroup>

• FindAttribute<TArray<int32>>(FVertexSetInterface::IndexAttribute, <Group>);
• FindAttribute<TArray<float>>(FVertexSetInterface::WeightAttribute, <Group>);

<Group> = FSelectionFacade::BoundGroup_<DependencyGroup>

• FindAttribute<TArray<int32>>(FVertexSetInterface::IndexAttribute, <Group>);
• FindAttribute<int32>(FVertexSetInterface::BoneIndexAttribute,<Group>);

<Group> = FSelectionFacade::WeightedBoundGroup_<DependencyGroup>

• FindAttribute<TArray<int32>>(FVertexSetInterface::IndexAttribute, <Group>);
  • FindAttribute<TArray<float>>(FVertexSetInterface::WeightAttribute, <Group>);
• FindAttribute<int32>(FVertexSetInterface::BoneIndexAttribute, <Group>);

Constructor & Destructor Documentation

FSelectionFacade() [1/2]

GeometryCollection::Facades::FSelectionFacade::FSelectionFacade

(

FManagedArrayCollection &

InSelf

)

FSelectionFacade Constuctor

FSelectionFacade() [2/2]

GeometryCollection::Facades::FSelectionFacade::FSelectionFacade

(

const FManagedArrayCollection &

InSelf

)

Member Function Documentation

AddSelection() [1/4]

FSelectionFacade::FSelectionKey GeometryCollection::Facades::FSelectionFacade::AddSelection	(	const int32	BoneIndex,
		const TArray< int32 > &	Indices,
		const TArray< float > &	Weights,
		FName	DependencyGroup,
		FName	BoneDependencyGroup = FName("")
	)

Add the indices to the FVertexSetInterface::BoundGroup

AddSelection() [2/4]

FSelectionFacade::FSelectionKey GeometryCollection::Facades::FSelectionFacade::AddSelection	(	const int32	BoneIndex,
		const TArray< int32 > &	Indices,
		FName	DependencyGroup,
		FName	BoneDependencyGroup = FName("")
	)

Add the indices to the FVertexSetInterface::BoundGroup

AddSelection() [3/4]

FSelectionFacade::FSelectionKey GeometryCollection::Facades::FSelectionFacade::AddSelection	(	const TArray< int32 > &	Indices,
		const TArray< float > &	Weights,
		FName	DependencyGroup
	)

Add the indices to the FVertexSetInterface::WeightedUnboundGroup

AddSelection() [4/4]

FSelectionFacade::FSelectionKey GeometryCollection::Facades::FSelectionFacade::AddSelection	(	const TArray< int32 > &	Indices,
		FName	DependencyGroup
	)

Add the indices to the FVertexSetInterface::UnboundGroup

GetSelection() [1/4]

void GeometryCollection::Facades::FSelectionFacade::GetSelection	(	const FSelectionKey &	Key,
		int32 &	BoneIndex,
		TArray< int32 > &	Indices
	)		const

Return the vertex list and bone index from the given key

Parameters

Key	: <GroupName and Index>
BoneIndex	: Return BoneIndex, INDEX_NONE if not found.
Indices	: Return indices, empty if not found.

GetSelection() [2/4]

void GeometryCollection::Facades::FSelectionFacade::GetSelection	(	const FSelectionKey &	Key,
		int32 &	BoneIndex,
		TArray< int32 > &	Indices,
		TArray< float > &	Weights
	)		const

Return the vertex list, bone index, and weights from the given key

Parameters

Key	: <GroupName and Index>
BoneIndex	: Return BoneIndex, INDEX_NONE if not found.
Indices	: Return indices, empty if not found.
Weights	: Return vertex weights, empty if not found.

GetSelection() [3/4]

void GeometryCollection::Facades::FSelectionFacade::GetSelection	(	const FSelectionKey &	Key,
		TArray< int32 > &	Indices
	)		const

Return the vertex list from the given key

Parameters

Key	: <GroupName and Index>
Indices	: Return indices, empty if not found.

GetSelection() [4/4]

void GeometryCollection::Facades::FSelectionFacade::GetSelection	(	const FSelectionKey &	Key,
		TArray< int32 > &	Indices,
		TArray< float > &	Weights
	)		const

Return the vertex list, bone index, and weights from the given key

Parameters

Key	: <GroupName and Index>
BoneIndex	: Return BoneIndex, INDEX_NONE if not found.
Indices	: Return indices, empty if not found.
Weights	: Return vertex weights, empty if not found.

IsConst()

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

inline

Is the facade defined constant.

Member Data Documentation

BoneIndexAttribute

const FName GeometryCollection::Facades::FSelectionFacade::BoneIndexAttribute = "BoneIndex"

static

BoundGroup

const FName GeometryCollection::Facades::FSelectionFacade::BoundGroup = "Bound"

static

IndexAttribute

const FName GeometryCollection::Facades::FSelectionFacade::IndexAttribute = "Index"

static

UnboundGroup

const FName GeometryCollection::Facades::FSelectionFacade::UnboundGroup = "Unbound"

static

WeightAttribute

const FName GeometryCollection::Facades::FSelectionFacade::WeightAttribute = "Weights"

static

WeightedBoundGroup

const FName GeometryCollection::Facades::FSelectionFacade::WeightedBoundGroup = "WeightedBound"

static

WeightedUnboundGroup

const FName GeometryCollection::Facades::FSelectionFacade::WeightedUnboundGroup = "WeightedUnbound"

static

---

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

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