1. Epic GamesDeveloper
  3. FGeometryCollection

FGeometryCollection

[FGeometryCollection](API\Runtime\Chaos\FGeometryCollection) ([FTransformCollection](API\Runtime\Chaos\FTransformCollection))

API > API/Runtime > API/Runtime/Chaos

FGeometryCollection (FTransformCollection)

   
Name FGeometryCollection
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/GeometryCollection.h
Include Path #include "GeometryCollection/GeometryCollection.h"

Syntax

class FGeometryCollection :  
    public FTransformCollection ,  
    public FGeometryCollectionConvexPropertiesInterface ,  
    public FGeometryCollectionProximityPropertiesInterface

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  GeometryCollection/GeometryCollection.h  
  GeometryCollection/GeometryCollection.h  
  GeometryCollection/GeometryCollection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FGeometryCollection()

   GeometryCollection/GeometryCollection.h  

Enums

Public

Name Remarks
ENodeFlags  
ESimulationTypes  

Typedefs

Name Type Remarks Include Path
Super FTransformCollection   GeometryCollection/GeometryCollection.h

Constants

Name Type Remarks Include Path
BoneColorAttribute const FName   GeometryCollection/GeometryCollection.h
BoundingBoxAttribute const FName   GeometryCollection/GeometryCollection.h
BreakingGroup const FName   GeometryCollection/GeometryCollection.h
ColorAttribute const FName   GeometryCollection/GeometryCollection.h
ExternalCollisionsAttribute const FName   GeometryCollection/GeometryCollection.h
FaceCountAttribute const FName   GeometryCollection/GeometryCollection.h
FaceIndicesAttribute const FName   GeometryCollection/GeometryCollection.h
FacesGroup const FName   GeometryCollection/GeometryCollection.h
FaceStartAttribute const FName   GeometryCollection/GeometryCollection.h
FaceVisibleAttribute const FName   GeometryCollection/GeometryCollection.h
GeometryGroup const FName   GeometryCollection/GeometryCollection.h
InnerRadiusAttribute const FName   GeometryCollection/GeometryCollection.h
MaterialGroup const FName   GeometryCollection/GeometryCollection.h
MaterialIDAttribute const FName   GeometryCollection/GeometryCollection.h
MaterialIndexAttribute const FName   GeometryCollection/GeometryCollection.h
OuterRadiusAttribute const FName   GeometryCollection/GeometryCollection.h
SimulatableParticlesAttribute const FName   GeometryCollection/GeometryCollection.h
SimulationTypeAttribute const FName   GeometryCollection/GeometryCollection.h
StatusFlagsAttribute const FName   GeometryCollection/GeometryCollection.h
TransformIndexAttribute const FName   GeometryCollection/GeometryCollection.h
TransformToGeometryIndexAttribute const FName   GeometryCollection/GeometryCollection.h
VertexBoneMapAttribute const FName   GeometryCollection/GeometryCollection.h
VertexCountAttribute const FName   GeometryCollection/GeometryCollection.h
VertexNormalAttribute const FName   GeometryCollection/GeometryCollection.h
VertexPositionAttribute const FName   GeometryCollection/GeometryCollection.h
VertexStartAttribute const FName   GeometryCollection/GeometryCollection.h
VertexTangentUAttribute const FName   GeometryCollection/GeometryCollection.h
VertexTangentVAttribute const FName   GeometryCollection/GeometryCollection.h
VerticesGroup const FName   GeometryCollection/GeometryCollection.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BoneMap TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
BoundingBox TManagedArray< FBox >   GeometryCollection/GeometryCollection.h  
Color TManagedArray< FLinearColor >   GeometryCollection/GeometryCollection.h  
Defaults FGeometryCollectionDefaults   GeometryCollection/GeometryCollection.h  
ExemplarIndex TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
FaceCount TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
FaceStart TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
Indices TManagedArray< FIntVector > Faces Group. GeometryCollection/GeometryCollection.h  
InitialDynamicState TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
InnerRadius TManagedArray< float >   GeometryCollection/GeometryCollection.h  
Internal TManagedArray< bool >   GeometryCollection/GeometryCollection.h  
MaterialID TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
MaterialIndex TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
Normal TManagedArray< FVector3f >   GeometryCollection/GeometryCollection.h  
OuterRadius TManagedArray< float >   GeometryCollection/GeometryCollection.h  
Sections TManagedArray< FGeometryCollectionSection > Material Group. GeometryCollection/GeometryCollection.h  
SimulationType TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
StatusFlags TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
TangentU TManagedArray< FVector3f >   GeometryCollection/GeometryCollection.h  
TangentV TManagedArray< FVector3f >   GeometryCollection/GeometryCollection.h  
TransformIndex TManagedArray< int32 > Geometry Group. GeometryCollection/GeometryCollection.h  
TransformToGeometryIndex TManagedArray< int32 > Transform Group. GeometryCollection/GeometryCollection.h  
Vertex TManagedArray< FVector3f > Vertices Group. GeometryCollection/GeometryCollection.h  
VertexCount TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
VertexStart TManagedArray< int32 >   GeometryCollection/GeometryCollection.h  
Visible TManagedArray< bool >   GeometryCollection/GeometryCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendCollection ( const FGeometryCollection& InCollection
)

 Append a FGeometryCollection to a FGeometryCollection GeometryCollection/GeometryCollection.h  

bool AppendEmbeddedInstance ( int32 InExemplarIndex,
int32 InParentIndex,
const FTransform& InTransform
)

 Append single embedded geometry. Returns true if the operation succeeds. GeometryCollection/GeometryCollection.h  

int32 AppendGeometry ( const FGeometryCollection& GeometryCollection,
int32 MaterialIDOffset,
bool ReindexAllMaterials,
const FTransform& TransformRoot
)

 Append a single geometric object to a FGeometryCollection GeometryCollection/GeometryCollection.h  

TArray< FGeometryCollectionSection > BuildMeshSections ( const TArray< FIntVector >& Indices,
const TArray< int32 >& BaseMeshOriginalIndicesIndex,
TArray< FIntVector >& RetIndices
) const

 Builds mesh sections for a given index buffer that could be a subset. GeometryCollection/GeometryCollection.h  

void ClearFlags ( int32 Element,
int32 InFlags
)

   GeometryCollection/GeometryCollection.h  

TArray< TArray< int32 > > ConnectionGraph()

 Connection of leaf geometry GeometryCollection/GeometryCollection.h  

void Empty()

 Empty each managed array in each group in order to reset the collection to an initial (empty) state. GeometryCollection/GeometryCollection.h  

TManagedArray< FVector2f > * FindUVLayer ( int32 UVLayer
)

   GeometryCollection/GeometryCollection.h  

const TManagedArray< FVector2f > * FindUVLayer ( int32 UVLayer
) const

   GeometryCollection/GeometryCollection.h  

FBoxSphereBounds GetBoundingBox()

 GetBoundingBox GeometryCollection/GeometryCollection.h  

const FVector2f & GetUV ( int32 VertexIndex,
int32 UVLayer
) const

   GeometryCollection/GeometryCollection.h  

bool HasContiguousFaces()

 Returns true if the faces are contiguous GeometryCollection/GeometryCollection.h  

bool HasContiguousRenderFaces()

 Returns true if the render faces are contiguous GeometryCollection/GeometryCollection.h  

bool HasContiguousVertices()

 Returns true if the vertices are contiguous GeometryCollection/GeometryCollection.h  

bool HasFlags ( int32 Element,
int32 InFlags
) const

   GeometryCollection/GeometryCollection.h  

bool HasVisibleGeometry()

 Returns true if there is anything to render GeometryCollection/GeometryCollection.h  

virtual void InitializeInterfaces()

 Initialize any interfaces on the geometry collection (i.e., the FGeometryCollectionConvexPropertiesInterface) GeometryCollection/GeometryCollection.h  

bool IsClustered ( int32 Element
) const

   GeometryCollection/GeometryCollection.h  

bool IsGeometry ( int32 Element
) const

   GeometryCollection/GeometryCollection.h  

bool IsRigid ( int32 Element
) const

   GeometryCollection/GeometryCollection.h  

bool IsTransform ( int32 Element
) const

   GeometryCollection/GeometryCollection.h  

bool IsVisible ( int32 Element
) const

 Return true if the Element contains any visible faces. GeometryCollection/GeometryCollection.h  

FVector2f & ModifyUV ( int32 VertexIndex,
int32 UVLayer
)

 Note: UVs have been reworked, and unfortunately there is not a safe path to provide the original UVs managed array as a deprecated accessor. GeometryCollection/GeometryCollection.h  

int32 NumUVLayers ()

 Returns number of UV layers represented by UV array. GeometryCollection/GeometryCollection.h  

void ReindexExemplarIndices ( TArray< int32 >& SortedRemovedIndices
)

 Reindex exemplar indices to reflect removed exemplars. GeometryCollection/GeometryCollection.h  
Reindex sections to keep polys with same materials together to reduce the number of draw calls GeometryCollection/GeometryCollection.h  

void SetFlags ( int32 Element,
int32 InFlags
)

   GeometryCollection/GeometryCollection.h  

bool SetNumUVLayers ( int32 NumLayers
)

 Update a geometry collection to have the target number of UV layers (must be in the range [1, MAX_UV_LAYERS)) GeometryCollection/GeometryCollection.h  

TArray< int32 > TransformSelectionToGeometryIndices ( const TArray< int32 >& Transforms
)

   GeometryCollection/GeometryCollection.h  
Update bounding box entries for the geometry GeometryCollection/GeometryCollection.h  

void UpdateGeometryVisibility ( const TArray< int32 >& NodeList,
bool VisibilityState
)

 Update the visibility of specified geometry nodes GeometryCollection/GeometryCollection.h  

void UpdateOldAttributeNames()

 Backwards compatibility GeometryCollection/GeometryCollection.h  

void WriteDataToHeaderFile ( const FString& Name,
const FString& Path
)

   GeometryCollection/GeometryCollection.h  

void WriteDataToOBJFile ( const FString& Name,
const FString& Path,
const bool WriteTopology,
const bool WriteAuxStructures
)

   GeometryCollection/GeometryCollection.h  

Overridden from FManagedArrayCollection

Name Remarks Include Path Unreal Specifiers

virtual bool IsAType ( FName InTypeName
) const

   GeometryCollection/GeometryCollection.h  

virtual void RemoveElements ( const FName& Group,
const TArray< int32 >& SortedDeletionList,
FProcessingParameters Params
)

 Remove Geometry and update dependent elements GeometryCollection/GeometryCollection.h  

virtual void ReorderElements ( FName Group,
const TArray< int32 >& NewOrder
)

 Reorders elements in a group. NewOrder must be the same length as the group. GeometryCollection/GeometryCollection.h  

virtual void Reset()

 Reset internal state GeometryCollection/GeometryCollection.h  

virtual void Serialize ( Chaos::FChaosArchive& Ar
)

 Serialize GeometryCollection/GeometryCollection.h  

virtual void SetDefaults ( FName Group,
uint32 StartSize,
uint32 NumElements
)

   GeometryCollection/GeometryCollection.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool BuildFaceToGeometryMapping ( bool InSaved
)

 Update Face Attributes based on changes in the group. GeometryCollection/GeometryCollection.h  

bool BuildVertexToGeometryMapping ( bool InSaved
)

 Build and Update Vertex Attributes based on changes in the group. GeometryCollection/GeometryCollection.h  

void Construct()

   GeometryCollection/GeometryCollection.h  

int32 GetLatestVersionNumber()

   GeometryCollection/GeometryCollection.h  

void RemoveGeometryElements ( const TArray< int32 >& SortedGeometryIndicesToDelete
)

 Remove Geometry elements i.e. verts, faces, etc, leaving the transform nodes intact GeometryCollection/GeometryCollection.h  

void ReorderGeometryElements ( const TArray< int32 >& NewOrder
)

 Reorder geometry elements. GeometryCollection/GeometryCollection.h  

void ReorderTransformElements ( const TArray< int32 >& NewOrder
)

 Reorder geometry elements based on the new transform order. GeometryCollection/GeometryCollection.h  

void UpdateFaceGroupElements()

   GeometryCollection/GeometryCollection.h  

void UpdateVerticesGroupElements()

   GeometryCollection/GeometryCollection.h  

Overridden from FManagedArrayCollection

Name Remarks Include Path Unreal Specifiers

virtual void Append ( const FManagedArrayCollection& Collection
)

 Append Collection and reindex dependencies on this collection. GeometryCollection/GeometryCollection.h  

virtual void MatchOptionalDefaultAttributes ( const FManagedArrayCollection& InCollection
)

 Virtual helper function called by CopyMatchingAttributesFrom; adds attributes 'default, but optional' attributes that are present in InCollection This is used by FGeometryCollection to make sure all UV layers are copied over by CopyMatchingAttributesFrom() GeometryCollection/GeometryCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AreCollisionParticlesEnabled()

   GeometryCollection/GeometryCollection.h  

static void DefineGeometrySchema ( FManagedArrayCollection&
)

   GeometryCollection/GeometryCollection.h  

static void Init ( FGeometryCollection* Collection,
const TArray< float >& RawVertexArray,
const TArray< int32 >& RawIndicesArray,
bool ReverseVertexOrder
)

   GeometryCollection/GeometryCollection.h  

static FGeometryCollection * NewGeometryCollection ( const TArray< float >& RawVertexArray,
const TArray< int32 >& RawIndicesArray,
const TArray< int32 >& RawBoneMapArray,
const TArray< FTransform >& RawTransformArray,
const TManagedArray< int32 >& RawLevelArray,
const TManagedArray< int32 >& RawParentArray,
const TManagedArray< TSet< int32 > >& RawChildrenArray,
const TManagedArray< int32 >& RawSimulationTypeArray,
const TManagedArray< int32 >& RawStatusFlagsArray,
FGeometryCollectionDefaults InDefaults
)

 Create a GeometryCollection from Vertex, Indices, BoneMap, Transform, BoneHierarchy arrays GeometryCollection/GeometryCollection.h  

static FGeometryCollection * NewGeometryCollection ( const TArray< float >& RawVertexArray,
const TArray< int32 >& RawIndicesArray,
bool ReverseVertexOrder,
FGeometryCollectionDefaults InDefaults
)

 Create a GeometryCollection from Vertex and Indices arrays GeometryCollection/GeometryCollection.h  
  GeometryCollection/GeometryCollection.h  

static FName StaticType()

   GeometryCollection/GeometryCollection.h  

static void UpdateBoundingBox ( FManagedArrayCollection&,
bool bSkipCheck
)

   GeometryCollection/GeometryCollection.h  

Operators

Name Remarks Include Path Unreal Specifiers
  GeometryCollection/GeometryCollection.h  
  GeometryCollection/GeometryCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page