Navigation
API > API/Runtime > API/Runtime/Chaos
FCollectionTransformSelectionFacade
Defines common API for selecting transforms on a collection
| Name | FCollectionTransformSelectionFacade |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/Facades/CollectionTransformSelectionFacade.h |
| Include Path | #include "GeometryCollection/Facades/CollectionTransformSelectionFacade.h" |
Syntax
class FCollectionTransformSelectionFacade
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCollectionTransformSelectionFacade
(
const FManagedArrayCollection& InSelf |
FCollectionTransformSelectionFacade Constuctor | GeometryCollection/Facades/CollectionTransformSelectionFacade.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChildrenAttribute | TManagedArrayAccessor< TSet< int32 > > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| ConstCollection | const FManagedArrayCollection & | This a const facade. | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
| FaceCountAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| FaceStartAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| IndicesAttribute | TManagedArrayAccessor< FIntVector > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| LevelAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| ParentAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| SimulationTypeAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| TransformIndexAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| TransformToGeometryIndexAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| VertexCountAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| VertexStartAttribute | TManagedArrayAccessor< int32 > | GeometryCollection/Facades/CollectionTransformSelectionFacade.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanSelectAll() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectBoundingBoxInBox() |
Returns indices of bones where BoundingBox of the bone is inside InBox | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool CanSelectBoundingBoxInSphere() |
Returns indices of bones where BoundingBox of the bone is inside a sphere | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool CanSelectCentroidInBox() |
Returns indices of bones where centroid of the bone is inside InBox | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool CanSelectCentroidInSphere() |
Returns indices of bones where centroid of the bone is inside a sphere | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool CanSelectChildren() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectCluster() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectContact() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectInverse() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectLeaf() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectLevel() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectParent() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectRandom() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectRootBones() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectSiblings() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool CanSelectVerticesInBox() |
Returns indices of bones where all the vertices or at least one vertex of the bone is inside InBox | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool CanSelectVerticesInSphere() |
Returns indices of bones where all the vertices or at least one vertex of the bone is inside a sphere | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
| Convert a CurveSelection to a FaceSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a CurveSelection to a GeometrySelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a CurveSelection to a TransformSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a CurveSelection to a VertexSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void ConvertEmbeddedSelectionToParents
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a FaceSelection to a CurveSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a FaceSelection to a GeometrySelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a FaceSelection to a TransformSelection, if bAllElementsMustBeSelected is true then all faces of a transform must be selected for the transform to be selected | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a FaceSelection to a VertexSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a GeometrySelection to a CurveSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a GeometrySelection to a FaceSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a GeometrySelection to a TransformSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a GeometrySelection to a VertexSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void ConvertSelectionToClusterNodes
(
TArray< int32 >& InOutSelection, |
Replace any Embedded or Rigid transforms in InOutSelection with their parent cluster. | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
void ConvertSelectionToRigidNodes
(
TArray< int32 >& InSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void ConvertSelectionToRigidNodes
(
const int32 Index, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a TransformSelection to a CurveSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a TransformSelection to a FaceSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a TransformSelection to a GeometrySelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a TransformSelection to a VertexSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a VertexSelection to a CurveSelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a VertexSelection to a FaceSelection, if bAllElementsMustBeSelected is true then all vertices of a face must be selectod for the face to be selected | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a VertexSelection to a GeometrySelection | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Convert a VertexSelection to a TransformSelection, if bAllElementsMustBeSelected is true then all vertices of a transform must be selected for the transform to be selected | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void DefineSchema() |
Create the facade attributes. | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
void FilterSelectionBySimulationType
(
TArray< int32 >& InOutSelection, |
Keep only the bones in the selection that match the input SimulationType | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
TArray< int32 > GetBonesByLevel
(
const int32 Level, |
Get bones filtered by the level as they would be in the editor; i.e., the bones with level <= the target Level, but with some additional logic for filtering, etc | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
TArray< int32 > GetBonesExactlyAtLevel
(
const int32 TargetLevel, |
Get bones exactly at a target level. A target level of -1 will return all bones. | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
| Return a map from parent of bone to the selected bones with that parent | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool HasSelectedAncestor
(
const TArray< int32 >& InSelection, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool IsARootBone
(
const int32 Index |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
bool IsConst() |
Is the facade defined constant. | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool IsValid() |
Is the Facade defined on the collection? | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
bool IsValidBone
(
const int32 Index |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void RemoveRootNodes
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void Sanitize
(
TArray< int32 >& InSelection, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectAll() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectBoundingBoxInBox
(
const FBox& InBox, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectBoundingBoxInSphere
(
const FSphere& InSphere, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Returns indices of bones where centroid of the bone is inside a convex hull Select by a float attribute in the collection, it can be any existing float attribute specified by GroupName/AttrName | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
| Select by an int attribute in the collection, it can be any existing int attribute specified by GroupName/AttrName | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectBySize
(
float SizeMin, |
Select transforms by their Size or Relative Size | GeometryCollection/Facades/CollectionTransformSelectionFacade.h | |
TArray< int32 > SelectByVolume
(
float VolumeMin, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectCentroidInBox
(
const FBox& InBox, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectCentroidInSphere
(
const FSphere& InSphere, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectChildren
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectCluster() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectContact
(
TArray< int32 >& InOutSelection, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectInverse
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectLeaf() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectLevel
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectNone() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectParent
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectRandom
(
bool bDeterministic, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectRootBones() |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
void SelectSiblings
(
TArray< int32 >& InOutSelection |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectVerticesInBox
(
const FBox& InBox, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h | ||
TArray< int32 > SelectVerticesInSphere
(
const FSphere& InSphere, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void SelectByPercentage
(
TArray< int32 >& InOutSelection, |
GeometryCollection/Facades/CollectionTransformSelectionFacade.h |