UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | List of all members
IGeometryCollectionExternalRenderInterface Class Referenceabstract

#include <GeometryCollectionExternalRenderInterface.h>

+ Inheritance diagram for IGeometryCollectionExternalRenderInterface:

Public Types

enum  EStateFlags { EState_Visible = 1 << 0 , EState_Broken = 1 << 1 , EState_ForcedBroken = 1 << 2 }
 

Public Member Functions

virtual bool ShouldUseNativeFallback (uint32 InStateFlags) const
 
virtual bool CanEverUseNativeFallback () const
 
virtual void OnRegisterGeometryCollection (UGeometryCollectionComponent &InComponent)=0
 
virtual void OnUnregisterGeometryCollection ()=0
 
virtual void UpdateState (UGeometryCollection const &InGeometryCollection, FTransform const &InComponentTransform, uint32 InStateFlags)=0
 
virtual void UpdateRootTransform (UGeometryCollection const &InGeometryCollection, FTransform const &InRootTransform)=0
 
virtual void UpdateRootTransforms (UGeometryCollection const &InGeometryCollection, FTransform const &InRootTransform, TArrayView< const FTransform3f > InRootLocalTransforms)
 
virtual void UpdateTransforms (UGeometryCollection const &InGeometryCollection, TArrayView< const FTransform3f > InTransforms)=0
 
virtual void UpdateState (UGeometryCollection const &InGeometryCollection, FTransform const &InComponentTransform, bool bInIsBroken, bool bInIsVisible)
 
virtual void UpdateTransforms (UGeometryCollection const &InGeometryCollection, TArrayView< const FMatrix > InMatrices)
 

Member Enumeration Documentation

◆ EStateFlags

enum IGeometryCollectionExternalRenderInterface::EStateFlags
Enumerator
EState_Visible 
EState_Broken 
EState_ForcedBroken 

Member Function Documentation

◆ CanEverUseNativeFallback()

virtual bool IGeometryCollectionExternalRenderInterface::CanEverUseNativeFallback ( ) const
inlinevirtual

Returns true if this renderer can ever return true for ShouldUseNativeFallback().

Reimplemented in UGeometryCollectionRootProxyRenderer.

◆ OnRegisterGeometryCollection()

virtual void IGeometryCollectionExternalRenderInterface::OnRegisterGeometryCollection ( UGeometryCollectionComponent &  InComponent)
pure virtual

Called on geometry collection component registration.

Implemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

◆ OnUnregisterGeometryCollection()

virtual void IGeometryCollectionExternalRenderInterface::OnUnregisterGeometryCollection ( )
pure virtual

Called on geometry collection component unregistration.

Implemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

◆ ShouldUseNativeFallback()

virtual bool IGeometryCollectionExternalRenderInterface::ShouldUseNativeFallback ( uint32  InStateFlags) const
inlinevirtual

Returns true if the custom renderer can't render for the given state, and requires native rendering instead.

Reimplemented in UGeometryCollectionRootProxyRenderer.

◆ UpdateRootTransform()

virtual void IGeometryCollectionExternalRenderInterface::UpdateRootTransform ( UGeometryCollection const &  InGeometryCollection,
FTransform const &  InRootTransform 
)
pure virtual

Update the root bone transform of the geometry collection. If the geometry collection is using of multiple proxy root meshes this transform applies to all of them.

Implemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

◆ UpdateRootTransforms()

virtual void IGeometryCollectionExternalRenderInterface::UpdateRootTransforms ( UGeometryCollection const &  InGeometryCollection,
FTransform const &  InRootTransform,
TArrayView< const FTransform3f >  InRootLocalTransforms 
)
inlinevirtual

Update the root proxy transforms of the geometry collection. If the geometry collection is using of multiple proxy root meshes, InRootTransforms is expected to contain an entry for each of them .

Parameters
InRootTransformComponent space root transform
InRootLocalTransformsRoot space local transforms

Reimplemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

◆ UpdateState() [1/2]

virtual void IGeometryCollectionExternalRenderInterface::UpdateState ( UGeometryCollection const &  InGeometryCollection,
FTransform const &  InComponentTransform,
bool  bInIsBroken,
bool  bInIsVisible 
)
inlinevirtual

◆ UpdateState() [2/2]

virtual void IGeometryCollectionExternalRenderInterface::UpdateState ( UGeometryCollection const &  InGeometryCollection,
FTransform const &  InComponentTransform,
uint32  InStateFlags 
)
pure virtual

Set the state of the geometry collection. This is used by the renderer to managed resources with regards to the state (see EStateFlags).

Implemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

◆ UpdateTransforms() [1/2]

virtual void IGeometryCollectionExternalRenderInterface::UpdateTransforms ( UGeometryCollection const &  InGeometryCollection,
TArrayView< const FMatrix >  InMatrices 
)
inlinevirtual

◆ UpdateTransforms() [2/2]

virtual void IGeometryCollectionExternalRenderInterface::UpdateTransforms ( UGeometryCollection const &  InGeometryCollection,
TArrayView< const FTransform3f >  InTransforms 
)
pure virtual

Update all the bones transforms.

Implemented in UGeometryCollectionISMPoolRenderer, and UGeometryCollectionRootProxyRenderer.

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