UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | List of all members
GeometryCollection::Facades::FRenderingFacade Class Reference

#include <CollectionRenderingFacade.h>

Public Types

typedef FGeometryCollectionSection FTriangleSection
 
typedef TMap< FString, int32 > FStringIntMap
 

Public Member Functions

CHAOS_API FRenderingFacade (FManagedArrayCollection &InSelf)
 
CHAOS_API FRenderingFacade (const FManagedArrayCollection &InSelf)
 
CHAOS_API void DefineSchema ()
 
bool IsConst () const
 
CHAOS_API bool IsValid () const
 
CHAOS_API bool CanRenderSurface () const
 
CHAOS_API int32 NumTriangles () const
 
CHAOS_API void AddPoint (const FVector3f &InPoint)
 
CHAOS_API void AddPoints (TArray< FVector3f > &&InPoints)
 
CHAOS_API void AddTriangle (const Chaos::FTriangle &InTriangle)
 
CHAOS_API void AddFaces (const TArray< FVector3f > &InVertices, TArray< FIntVector > &InIndices, TArray< FLinearColor > &InColors)
 
CHAOS_API void AddBox (const FBox &InBox)
 
CHAOS_API void AddBox (const FVector3f &InMinVertex, const FVector3f &InMaxVertex)
 
CHAOS_API void AddBoxes (const TArray< FBox > &InBoxes)
 
CHAOS_API void AddSphere (const FSphere &InSphere, const FLinearColor &InColor)
 
CHAOS_API void AddSphere (const FVector3f &InCenter, const float InRadius, const FLinearColor &InColor)
 
CHAOS_API void AddSpheres (const TArray< FSphere > &InSpheres, const FLinearColor &InColor)
 
CHAOS_API void AddCapsule (const float Length, const float Radius, FLinearColor Color=FLinearColor::White, int32 Sides=8)
 
CHAOS_API void AddSurface (TArray< FVector3f > &&InVertices, TArray< FIntVector > &&InIndices, TArray< FVector3f > &&InNormals, TArray< FLinearColor > &&InColors)
 
CHAOS_API void AddSurface (TArray< FVector3f > &&InVertices, TArray< FIntVector > &&InIndices, TArray< FVector3f > &&InNormals, TArray< FLinearColor > &&InColors, TArray< TArray< FVector2f > > &&InUVs, TArray< int32 > &&InMaterialIDs, TArray< FString > &&MaterialPaths)
 
CHAOS_API void AddSurfaceBoneWeightsAndIndices (TArray< TArray< float > > &&InBoneWeights, TArray< TArray< int32 > > &&InBoneIndices)
 
CHAOS_API void AddTetrahedron (const TArray< FVector3f > &InVertices, const FIntVector4 &InIndices)
 
CHAOS_API void AddTetrahedrons (TArray< FVector3f > &&InVertices, TArray< FIntVector4 > &&InIndices)
 
const TManagedArray< FIntVector > & GetIndices () const
 
const TManagedArray< int32 > & GetMaterialID () const
 
const TManagedArray< FTriangleSection > & GetTriangleSections () const
 
CHAOS_API TArray< FTriangleSection > BuildMeshSections (const TArray< FIntVector > &Indices, TArray< int32 > BaseMeshOriginalIndicesIndex, TArray< FIntVector > &RetIndices) const
 
const TManagedArray< FVector3f > & GetVertices () const
 
TManagedArray< FVector3f > & ModifyVertices ()
 
const TManagedArray< FVector3f > & GetNormals () const
 
TManagedArray< FVector3f > & ModifyNormals ()
 
const TManagedArray< int32 > & GetVertexSelection () const
 
TManagedArray< int32 > & ModifyVertexSelection ()
 
const TManagedArray< int32 > & GetVertexToGeometryIndex () const
 
TManagedArray< int32 > & ModifyVertexToGeometryIndex ()
 
const TManagedArray< int32 > & GetVertexHitProxyIndex () const
 
TManagedArray< int32 > & ModifyVertexHitProxyIndex ()
 
int32 NumVertices () const
 
const TManagedArray< FLinearColor > & GetVertexColor () const
 
TManagedArray< FLinearColor > & ModifyVertexColor ()
 
const TManagedArray< TArray< FVector2f > > & GetVertexUV () const
 
TManagedArray< TArray< FVector2f > > & ModifyVertexUV ()
 
const TManagedArray< TArray< float > > * FindBoneWeights () const
 
const TManagedArray< TArray< int32 > > * FindBoneIndices () const
 
CHAOS_API int32 StartGeometryGroup (FString InName, const FTransform &InTm=FTransform::Identity)
 
CHAOS_API void EndGeometryGroup (int32 InGeometryGroupIndex)
 
CHAOS_API void SetGroupTransform (int32 InGeometryGroupIndex, const FTransform &InTm)
 
int32 NumGeometry () const
 
const TManagedArray< FString > & GetGeometryName () const
 
const TManagedArray< FTransform > & GetGeometryTransform () const
 
const TManagedArray< int32 > & GetGeometryHitProxyIndex () const
 
TManagedArray< int32 > & ModifyGeometryHitProxyIndex ()
 
const TManagedArray< int32 > & GetVertexStart () const
 
const TManagedArray< int32 > & GetVertexCount () const
 
const TManagedArray< int32 > & GetIndicesStart () const
 
const TManagedArray< int32 > & GetIndicesCount () const
 
const TManagedArray< int32 > & GetSelectionState () const
 
TManagedArray< int32 > & ModifySelectionState ()
 
CHAOS_API int32 NumVerticesOnSelectedGeometry () const
 
CHAOS_API FStringIntMap GetGeometryNameToIndexMap () const
 
const TManagedArray< FString > & GetMaterialPaths () const
 
const TManagedArray< int32 > & GetMaterialStart () const
 
const TManagedArray< int32 > & GetMaterialCount () const
 
int32 NumMaterials () const
 

Detailed Description

FRenderingFacade

Defines common API for storing rendering data.

Member Typedef Documentation

◆ FStringIntMap

typedef TMap<FString, int32> GeometryCollection::Facades::FRenderingFacade::FStringIntMap

◆ FTriangleSection

typedef FGeometryCollectionSection GeometryCollection::Facades::FRenderingFacade::FTriangleSection

Constructor & Destructor Documentation

◆ FRenderingFacade() [1/2]

GeometryCollection::Facades::FRenderingFacade::FRenderingFacade ( FManagedArrayCollection &  InSelf)

FRenderingFacade Constuctor

Parameters
VertexDependencyGroup: GroupName the index attribute is dependent on.

◆ FRenderingFacade() [2/2]

GeometryCollection::Facades::FRenderingFacade::FRenderingFacade ( const FManagedArrayCollection &  InSelf)

Member Function Documentation

◆ AddBox() [1/2]

void GeometryCollection::Facades::FRenderingFacade::AddBox ( const FBox &  InBox)

Add a box to the rendering view.

◆ AddBox() [2/2]

void GeometryCollection::Facades::FRenderingFacade::AddBox ( const FVector3f &  InMinVertex,
const FVector3f &  InMaxVertex 
)

◆ AddBoxes()

void GeometryCollection::Facades::FRenderingFacade::AddBoxes ( const TArray< FBox > &  InBoxes)

Add boxes to the rendering view.

◆ AddCapsule()

void GeometryCollection::Facades::FRenderingFacade::AddCapsule ( const float  Length,
const float  Radius,
FLinearColor  Color = FLinearColor::White,
int32  Sides = 8 
)

Add a capsule to the rendering view

◆ AddFaces()

void GeometryCollection::Facades::FRenderingFacade::AddFaces ( const TArray< FVector3f > &  InVertices,
TArray< FIntVector > &  InIndices,
TArray< FLinearColor > &  InColors 
)

Given a list of triangles, expand them to faces with face-normals

◆ AddPoint()

void GeometryCollection::Facades::FRenderingFacade::AddPoint ( const FVector3f &  InPoint)

Add a point to the rendering view.

◆ AddPoints()

void GeometryCollection::Facades::FRenderingFacade::AddPoints ( TArray< FVector3f > &&  InPoints)

Add point cloud to the rendering view.

◆ AddSphere() [1/2]

void GeometryCollection::Facades::FRenderingFacade::AddSphere ( const FSphere &  InSphere,
const FLinearColor &  InColor 
)

Add a sphere to the rendering view.

◆ AddSphere() [2/2]

void GeometryCollection::Facades::FRenderingFacade::AddSphere ( const FVector3f &  InCenter,
const float  InRadius,
const FLinearColor &  InColor 
)

◆ AddSpheres()

void GeometryCollection::Facades::FRenderingFacade::AddSpheres ( const TArray< FSphere > &  InSpheres,
const FLinearColor &  InColor 
)

Add spheres to the rendering view.

◆ AddSurface() [1/2]

void GeometryCollection::Facades::FRenderingFacade::AddSurface ( TArray< FVector3f > &&  InVertices,
TArray< FIntVector > &&  InIndices,
TArray< FVector3f > &&  InNormals,
TArray< FLinearColor > &&  InColors 
)

Add a surface to the rendering view.

◆ AddSurface() [2/2]

void GeometryCollection::Facades::FRenderingFacade::AddSurface ( TArray< FVector3f > &&  InVertices,
TArray< FIntVector > &&  InIndices,
TArray< FVector3f > &&  InNormals,
TArray< FLinearColor > &&  InColors,
TArray< TArray< FVector2f > > &&  InUVs,
TArray< int32 > &&  InMaterialIDs,
TArray< FString > &&  MaterialPaths 
)

Add a surface with UV layers, Material IDs and material paths to the rendering view.

◆ AddSurfaceBoneWeightsAndIndices()

void GeometryCollection::Facades::FRenderingFacade::AddSurfaceBoneWeightsAndIndices ( TArray< TArray< float > > &&  InBoneWeights,
TArray< TArray< int32 > > &&  InBoneIndices 
)

Add surface bone weights and indices to the rendering view - AddSurface must have been called before .

◆ AddTetrahedron()

void GeometryCollection::Facades::FRenderingFacade::AddTetrahedron ( const TArray< FVector3f > &  InVertices,
const FIntVector4 &  InIndices 
)

Add a tetrahedron to the rendering view.

◆ AddTetrahedrons()

void GeometryCollection::Facades::FRenderingFacade::AddTetrahedrons ( TArray< FVector3f > &&  InVertices,
TArray< FIntVector4 > &&  InIndices 
)

Add a tetrahedrons to the rendering view.

◆ AddTriangle()

void GeometryCollection::Facades::FRenderingFacade::AddTriangle ( const Chaos::FTriangle &  InTriangle)

Add a triangle to the rendering view.

◆ BuildMeshSections()

TArray< FRenderingFacade::FTriangleSection > GeometryCollection::Facades::FRenderingFacade::BuildMeshSections ( const TArray< FIntVector > &  Indices,
TArray< int32 >  BaseMeshOriginalIndicesIndex,
TArray< FIntVector > &  RetIndices 
) const

BuildMeshSections

◆ CanRenderSurface()

bool GeometryCollection::Facades::FRenderingFacade::CanRenderSurface ( ) const

Does it support rendering surfaces.

◆ DefineSchema()

void GeometryCollection::Facades::FRenderingFacade::DefineSchema ( )

Create the facade.

◆ EndGeometryGroup()

void GeometryCollection::Facades::FRenderingFacade::EndGeometryGroup ( int32  InGeometryGroupIndex)

Geometry Group End :

◆ FindBoneIndices()

const TManagedArray< TArray< int32 > > * GeometryCollection::Facades::FRenderingFacade::FindBoneIndices ( ) const
inline

◆ FindBoneWeights()

const TManagedArray< TArray< float > > * GeometryCollection::Facades::FRenderingFacade::FindBoneWeights ( ) const
inline

◆ GetGeometryHitProxyIndex()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetGeometryHitProxyIndex ( ) const
inline

HitProxyIDAttribute

◆ GetGeometryName()

const TManagedArray< FString > & GeometryCollection::Facades::FRenderingFacade::GetGeometryName ( ) const
inline

GeometryNameAttribute

◆ GetGeometryNameToIndexMap()

FRenderingFacade::FStringIntMap GeometryCollection::Facades::FRenderingFacade::GetGeometryNameToIndexMap ( ) const

GetGeometryNameToIndexMap

◆ GetGeometryTransform()

const TManagedArray< FTransform > & GeometryCollection::Facades::FRenderingFacade::GetGeometryTransform ( ) const
inline

GeometryTransformAttribute

◆ GetIndices()

const TManagedArray< FIntVector > & GeometryCollection::Facades::FRenderingFacade::GetIndices ( ) const
inline

GetIndices

◆ GetIndicesCount()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetIndicesCount ( ) const
inline

IndicesCountAttribute

◆ GetIndicesStart()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetIndicesStart ( ) const
inline

IndicesStartAttribute

◆ GetMaterialCount()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetMaterialCount ( ) const
inline

GetMaterialCount

◆ GetMaterialID()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetMaterialID ( ) const
inline

GetMaterialID

◆ GetMaterialPaths()

const TManagedArray< FString > & GeometryCollection::Facades::FRenderingFacade::GetMaterialPaths ( ) const
inline

GetMaterialPathAttribute

◆ GetMaterialStart()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetMaterialStart ( ) const
inline

GetMaterialStart

◆ GetNormals()

const TManagedArray< FVector3f > & GeometryCollection::Facades::FRenderingFacade::GetNormals ( ) const
inline

GetNormals

◆ GetSelectionState()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetSelectionState ( ) const
inline

SelectionState

◆ GetTriangleSections()

const TManagedArray< FTriangleSection > & GeometryCollection::Facades::FRenderingFacade::GetTriangleSections ( ) const
inline

GetTriangleSections

◆ GetVertexColor()

const TManagedArray< FLinearColor > & GeometryCollection::Facades::FRenderingFacade::GetVertexColor ( ) const
inline

GetVertexColorAttribute

◆ GetVertexCount()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetVertexCount ( ) const
inline

VertexCountAttribute

◆ GetVertexHitProxyIndex()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetVertexHitProxyIndex ( ) const
inline

HitProxyIDAttribute

◆ GetVertexSelection()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetVertexSelection ( ) const
inline

GetVertexSelectionAttribute

◆ GetVertexStart()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetVertexStart ( ) const
inline

VertexStartAttribute

◆ GetVertexToGeometryIndex()

const TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::GetVertexToGeometryIndex ( ) const
inline

GetVertexToGeometryIndexAttribute

◆ GetVertexUV()

const TManagedArray< TArray< FVector2f > > & GeometryCollection::Facades::FRenderingFacade::GetVertexUV ( ) const
inline

GetVertexUVAttribute

◆ GetVertices()

const TManagedArray< FVector3f > & GeometryCollection::Facades::FRenderingFacade::GetVertices ( ) const
inline

GetVertices

◆ IsConst()

bool GeometryCollection::Facades::FRenderingFacade::IsConst ( ) const
inline

Is the facade defined constant.

◆ IsValid()

bool GeometryCollection::Facades::FRenderingFacade::IsValid ( ) const

Is the Facade defined on the collection?

◆ ModifyGeometryHitProxyIndex()

TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::ModifyGeometryHitProxyIndex ( )
inline

◆ ModifyNormals()

TManagedArray< FVector3f > & GeometryCollection::Facades::FRenderingFacade::ModifyNormals ( )
inline

◆ ModifySelectionState()

TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::ModifySelectionState ( )
inline

◆ ModifyVertexColor()

TManagedArray< FLinearColor > & GeometryCollection::Facades::FRenderingFacade::ModifyVertexColor ( )
inline

◆ ModifyVertexHitProxyIndex()

TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::ModifyVertexHitProxyIndex ( )
inline

◆ ModifyVertexSelection()

TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::ModifyVertexSelection ( )
inline

◆ ModifyVertexToGeometryIndex()

TManagedArray< int32 > & GeometryCollection::Facades::FRenderingFacade::ModifyVertexToGeometryIndex ( )
inline

◆ ModifyVertexUV()

TManagedArray< TArray< FVector2f > > & GeometryCollection::Facades::FRenderingFacade::ModifyVertexUV ( )
inline

◆ ModifyVertices()

TManagedArray< FVector3f > & GeometryCollection::Facades::FRenderingFacade::ModifyVertices ( )
inline

◆ NumGeometry()

int32 GeometryCollection::Facades::FRenderingFacade::NumGeometry ( ) const
inline

◆ NumMaterials()

int32 GeometryCollection::Facades::FRenderingFacade::NumMaterials ( ) const
inline

Total NumMaterials

◆ NumTriangles()

int32 GeometryCollection::Facades::FRenderingFacade::NumTriangles ( ) const

Number of triangles to render.

◆ NumVertices()

int32 GeometryCollection::Facades::FRenderingFacade::NumVertices ( ) const
inline

NumVertices

◆ NumVerticesOnSelectedGeometry()

int32 GeometryCollection::Facades::FRenderingFacade::NumVerticesOnSelectedGeometry ( ) const

NumVerticesOnSelectedGeometry

◆ SetGroupTransform()

void GeometryCollection::Facades::FRenderingFacade::SetGroupTransform ( int32  InGeometryGroupIndex,
const FTransform &  InTm 
)

Modify the transform of a pre-declared group

◆ StartGeometryGroup()

int32 GeometryCollection::Facades::FRenderingFacade::StartGeometryGroup ( FString  InName,
const FTransform &  InTm = FTransform::Identity 
)

Geometry Group Start :

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