1. Epic GamesDeveloper
  3. FGeometryCollection

FGeometryCollection

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

Unreal Engine C++ API Reference > Runtime > Chaos > GeometryCollection

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/GeometryCollection.h
Include #include "GeometryCollection/GeometryCollection.h"

Syntax

class FGeometryCollection :  
    public FTransformCollection,  
    public FGeometryCollectionConvexPropertiesInterface,  
    public FGeometryCollectionProximityPropertiesInterface

Remarks

FGeometryCollection (FTransformCollection)

Variables

  Type Name Description
Public variable TManagedArray< int32 > BoneMap  
Public variable TManagedArray< FBox > BoundingBox  
Public variable TManagedArray< FLinearColor > Color  
Public variable TManagedArray< int32 > ExemplarIndex  
Public variable TManagedArray< int32 > FaceCount  
Public variable TManagedArray< int32 > FaceStart  
Public variable TManagedArray< FIntVector > Indices Faces Group.
Public variable TManagedArray< int32 > InitialDynamicState  
Public variable TManagedArray< float > InnerRadius  
Public variable TManagedArray< bool > Internal  
Public variable TManagedArray< int32 > MaterialID  
Public variable TManagedArray< int32 > MaterialIndex  
Public variable TManagedArray< FVector3f > Normal  
Public variable TManagedArray< float > OuterRadius  
Public variable TManagedArray< FGeometryCollectionSection > Sections Material Group.
Public variable TManagedArray< int32 > SimulationType  
Public variable TManagedArray< int32 > StatusFlags  
Public variable TManagedArray< FVector3f > TangentU  
Public variable TManagedArray< FVector3f > TangentV  
Public variable TManagedArray< int32 > TransformIndex Geometry Group.
Public variable TManagedArray< int32 > TransformToGeometryIndex Transform Group.
Public variable TManagedArray< FVector3f > Vertex Vertices Group.
Public variable TManagedArray< int32 > VertexCount  
Public variable TManagedArray< int32 > VertexStart  
Public variable TManagedArray< bool > Visible  

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function bool

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

 Append single embedded geometry. Returns true if the operation succeeds.
Public function int32

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

 Append a single geometric object to a FGeometryCollection
Public function Static bool  
Protected function bool

BuildFaceToGeometryMapping ( bool InSaved
)

 Update Face Attributes based on changes in the group.
Public function Const TArray< FGeometryCollectionSection >

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

 Builds mesh sections for a given index buffer that could be a subset.
Protected function bool

BuildVertexToGeometryMapping ( bool InSaved
)

 Build and Update Vertex Attributes based on changes in the group.
Public function void

ClearFlags ( int32 Element,
int32 InFlags
)

  
Public function TArray< TArray< int32 > > Connection of leaf geometry
Protected function void  
Public function Static void  
Public function void

Empty ()

 Empty each managed array in each group in order to reset the collection to an initial (empty) state.
Public function TManagedArray< FVector2f > *

FindUVLayer ( int32 UVLayer
)

  
Public function Const const TManagedArray< FVector2f > *

FindUVLayer ( int32 UVLayer
)

  
Public function Const FBoxSphereBounds GetBoundingBox
Protected function Const constexpr int32  
Public function Const const FVector2f &

GetUV ( int32 VertexIndex,
int32 UVLayer
)

  
Public function Const bool Returns true if the faces are contiguous
Public function Const bool Returns true if the render faces are contiguous
Public function Const bool Returns true if the vertices are contiguous
Public function Const bool

HasFlags ( int32 Element,
int32 InFlags
)

  
Public function Const bool Returns true if there is anything to render
Public function Static void

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

  
Public function Virtual void Initialize any interfaces on the geometry collection (i.e., the FGeometryCollectionConvexPropertiesInterface)
Public function Const bool

IsClustered ( int32 Element
)

  
Public function Const bool

IsGeometry ( int32 Element
)

  
Public function Const bool

IsRigid ( int32 Element
)

  
Public function Const bool

IsTransform ( int32 Element
)

  
Public function Const bool

IsVisible ( int32 Element
)

 Return true if the Element contains any visible faces.
Public function 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.
Public function 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
)

 Create a GeometryCollection from Vertex, Indices, BoneMap, Transform, BoneHierarchy arrays
Public function Static FGeometryCollection *

NewGeometryCollection ( const TArray< float >& RawVertexArray,
const TArray< int32 >& RawIndicesArray,
bool ReverseVertexOrder
)

 Create a GeometryCollection from Vertex and Indices arrays
Public function Const int32 Returns number of UV layers represented by UV array.
Public function void

ReindexExemplarIndices ( TArray< int32 >& SortedRemovedIndices
)

 Reindex exemplar indices to reflect removed exemplars.
Public function Static void Reindex sections to keep polys with same materials together to reduce the number of draw calls
Public function void Reindex sections to keep polys with same materials together to reduce the number of draw calls
Protected function void

RemoveGeometryElements ( const TArray< int32 >& SortedGeometryIndicesToDelete
)

 Remove Geometry elements i.e. verts, faces, etc, leaving the transform nodes intact
Protected function void

ReorderGeometryElements ( const TArray< int32 >& NewOrder
)

 Reorder geometry elements.
Protected function void

ReorderTransformElements ( const TArray< int32 >& NewOrder
)

 Reorder geometry elements based on the new transform order.
Public function void

SetFlags ( int32 Element,
int32 InFlags
)

  
Public function 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))
Public function Static FName  
Public function void Update bounding box entries for the geometry
Public function Static void Update bounding box entries for the geometry
Protected function void  
Public function void

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

 Update the visibility of specified geometry nodes
Public function void Backwards compatibility
Protected function void  
Public function void

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

  
Public function void

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

  

Overridden from FManagedArrayCollection

  Type Name Description
Public function Virtual Const bool

IsAType ( FName InTypeName
)

  
Protected function Virtual void 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()
Public function Virtual void

RemoveElements ( const FName& Group,
const TArray< int32 >& DeletionList,
FProcessingParameters Params
)

 Remove Geometry and update dependent elements
Public function Virtual void

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

 Reorders elements in a group. NewOrder must be the same length as the group.
Public function Virtual void

Reset ()

 Reset internal state
Public function Virtual void Serialize
Public function Virtual void

SetDefaults ( FName Group,
uint32 StartSize,
uint32 NumElements
)

  

Operators

  Type Name Description
Public function FGeometryCollection &  
Public function FGeometryCollection &  

Enums

  Type Name Description
Public enum ENodeFlags    
Public enum ESimulationTypes    

Typedefs

Name Description
Super  

Constants

Name Description
BreakingGroup  
FacesGroup  
GeometryGroup  
MaterialGroup  
SimulatableParticlesAttribute  
SimulationTypeAttribute  
StatusFlagsAttribute  
VerticesGroup  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page