1. Epic GamesDeveloper
  3. FRenderingFacade

FRenderingFacade

[FRenderingFacade](API\Runtime\Chaos\FRenderingFacade)

API > API/Runtime > API/Runtime/Chaos

FRenderingFacade

Defines common API for storing rendering data.

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

Syntax

class FRenderingFacade

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
FRenderingFacade Constuctor GeometryCollection/Facades/CollectionRenderingFacade.h  
  GeometryCollection/Facades/CollectionRenderingFacade.h  

Typedefs

Name Type Remarks Include Path
FStringIntMap TMap< FString, int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h
FTriangleSection FGeometryCollectionSection   GeometryCollection/Facades/CollectionRenderingFacade.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BoneIndicesAttribute TManagedArrayAccessor< TArray< int32 > >   GeometryCollection/Facades/CollectionRenderingFacade.h  
BoneWeightsAttribute TManagedArrayAccessor< TArray< float > >   GeometryCollection/Facades/CollectionRenderingFacade.h  
Collection FManagedArrayCollection *   GeometryCollection/Facades/CollectionRenderingFacade.h  
ConstCollection const FManagedArrayCollection &   GeometryCollection/Facades/CollectionRenderingFacade.h  
GeometryHitProxyIndexAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
GeometryNameAttribute TManagedArrayAccessor< FString >   GeometryCollection/Facades/CollectionRenderingFacade.h  
GeometrySelectionAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
GeometryTransformAttribute TManagedArrayAccessor< FTransform >   GeometryCollection/Facades/CollectionRenderingFacade.h  
IndicesAttribute TManagedArrayAccessor< FIntVector >   GeometryCollection/Facades/CollectionRenderingFacade.h  
IndicesCountAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
IndicesStartAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
MaterialCountAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
MaterialIDAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
MaterialPathAttribute TManagedArrayAccessor< FString >   GeometryCollection/Facades/CollectionRenderingFacade.h  
MaterialStartAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
TriangleSectionAttribute TManagedArrayAccessor< FTriangleSection >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexAttribute TManagedArrayAccessor< FVector3f >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexColorAttribute TManagedArrayAccessor< FLinearColor >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexCountAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexHitProxyIndexAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexNormalAttribute TManagedArrayAccessor< FVector3f >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexSelectionAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexStartAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexToGeometryIndexAttribute TManagedArrayAccessor< int32 >   GeometryCollection/Facades/CollectionRenderingFacade.h  
VertexUVAttribute TManagedArrayAccessor< TArray< FVector2f > >   GeometryCollection/Facades/CollectionRenderingFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBox ( const FVector3f& InMinVertex,
const FVector3f& InMaxVertex
)

   GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddBox ( const FBox& InBox
)

 Add a box to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddBoxes ( const TArray< FBox >& InBoxes
)

 Add boxes to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddCapsule ( const float Length,
const float Radius,
FLinearColor Color,
int32 Sides
)

 Add a capsule to the rendering view GeometryCollection/Facades/CollectionRenderingFacade.h  

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

 Given a list of triangles, expand them to faces with face-normals GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddPoint ( const FVector3f& InPoint
)

 Add a point to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddPoints ( TArray< FVector3f >&& InPoints
)

 Add point cloud to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddSphere ( const FVector3f& InCenter,
const float InRadius,
const FLinearColor& InColor
)

   GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddSphere ( const FSphere& InSphere,
const FLinearColor& InColor
)

 Add a sphere to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddSpheres ( const TArray< FSphere >& InSpheres,
const FLinearColor& InColor
)

 Add spheres to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void 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. GeometryCollection/Facades/CollectionRenderingFacade.h  

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

 Add a surface to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void 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 . GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddTetrahedron ( const TArray< FVector3f >& InVertices,
const FIntVector4& InIndices
)

 Add a tetrahedron to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddTetrahedrons ( TArray< FVector3f >&& InVertices,
TArray< FIntVector4 >&& InIndices
)

 Add a tetrahedrons to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

void AddTriangle ( const Chaos::FTriangle& InTriangle
)

 Add a triangle to the rendering view. GeometryCollection/Facades/CollectionRenderingFacade.h  

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

 BuildMeshSections GeometryCollection/Facades/CollectionRenderingFacade.h  

bool CanRenderSurface()

 Does it support rendering surfaces. GeometryCollection/Facades/CollectionRenderingFacade.h  

void DefineSchema()

 Create the facade. GeometryCollection/Facades/CollectionRenderingFacade.h  

void EndGeometryGroup ( int32 InGeometryGroupIndex
)

 Geometry Group End : GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< TArray< int32 > > * FindBoneIndices()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< TArray< float > > * FindBoneWeights()

 Optional per vertex bone attributes GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetGeometryHitProxyIndex()

 HitProxyIDAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FString > & GetGeometryName()

 GeometryNameAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

FStringIntMap GetGeometryNameToIndexMap()

 GetGeometryNameToIndexMap GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FTransform > & GetGeometryTransform()

 GeometryTransformAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FIntVector > & GetIndices()

 GetIndices GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetIndicesCount()

 IndicesCountAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetIndicesStart()

 IndicesStartAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetMaterialCount()

 GetMaterialCount GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetMaterialID()

 GetMaterialID GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FString > & GetMaterialPaths()

 GetMaterialPathAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetMaterialStart()

 GetMaterialStart GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FVector3f > & GetNormals()

 GetNormals GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetSelectionState()

 SelectionState GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FTriangleSection > & GetTriangleSections()

 GetTriangleSections GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FLinearColor > & GetVertexColor()

 GetVertexColorAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetVertexCount()

 VertexCountAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetVertexHitProxyIndex()

 HitProxyIDAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetVertexSelection()

 GetVertexSelectionAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetVertexStart()

 VertexStartAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< int32 > & GetVertexToGeometryIndex()

 GetVertexToGeometryIndexAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< TArray< FVector2f > > & GetVertexUV()

 GetVertexUVAttribute GeometryCollection/Facades/CollectionRenderingFacade.h  

const TManagedArray< FVector3f > & GetVertices()

 Vertices GetVertices GeometryCollection/Facades/CollectionRenderingFacade.h  

bool IsConst()

 Is the facade defined constant. GeometryCollection/Facades/CollectionRenderingFacade.h  

bool IsValid()

 Is the Facade defined on the collection? GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< int32 > & ModifyGeometryHitProxyIndex()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< FVector3f > & ModifyNormals()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< int32 > & ModifySelectionState()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< FLinearColor > & ModifyVertexColor()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< int32 > & ModifyVertexHitProxyIndex()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< int32 > & ModifyVertexSelection()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< int32 > & ModifyVertexToGeometryIndex()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< TArray< FVector2f > > & ModifyVertexUV()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

TManagedArray< FVector3f > & ModifyVertices()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 NumGeometry()

   GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 NumMaterials()

 Total NumMaterials GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 NumTriangles()

 Facade API Number of triangles to render. GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 NumVertices()

 NumVertices GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 NumVerticesOnSelectedGeometry()

 NumVerticesOnSelectedGeometry GeometryCollection/Facades/CollectionRenderingFacade.h  

void SetGroupTransform ( int32 InGeometryGroupIndex,
const FTransform& InTm
)

 Modify the transform of a pre-declared group GeometryCollection/Facades/CollectionRenderingFacade.h  

int32 StartGeometryGroup ( FString InName,
const FTransform& InTm
)

 Geometry Group Attributes Geometry Group Start : GeometryCollection/Facades/CollectionRenderingFacade.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page