UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FPrimitiveSceneDesc Struct Reference

#include <PrimitiveSceneDesc.h>

Public Member Functions

FString GetFullName ()
 
FString GetName ()
 
bool IsUnreachable ()
 
bool ShouldRecreateProxyOnUpdateTransform ()
 
FThreadSafeCounterGetAttachmentCounter () const
 
FPrimitiveComponentId GetPrimitiveSceneId () const
 
FPrimitiveComponentId GetLODParentId () const
 
FPrimitiveComponentId GetLightingAttachmentId () const
 
void SetLODParentId (FPrimitiveComponentId Id)
 
void SetLightingAttachmentId (FPrimitiveComponentId Id)
 
double GetLastSubmitTime ()
 
void SetLastSubmitTime (double InSubmitTime)
 
EComponentMobility::Type GetMobility ()
 
FMatrix GetRenderMatrix ()
 
const FMatrixGetRenderMatrix () const
 
FVector GetActorPositionForRenderer ()
 
UWorldGetWorld ()
 
FBoxSphereBounds GetBounds ()
 
FBoxSphereBounds GetLocalBounds ()
 
FPrimitiveSceneProxyGetSceneProxy () const
 
FPrimitiveSceneProxyDescGetSceneProxyDesc ()
 
FPrimitiveSceneInfoDataGetSceneData ()
 
void ReleaseSceneProxy ()
 
IPrimitiveComponentGetPrimitiveComponentInterface ()
 
const IPrimitiveComponentGetPrimitiveComponentInterface () const
 
UPackageGetOutermost () const
 

Public Attributes

FPrimitiveSceneProxyDescProxyDesc = nullptr
 
IPrimitiveComponentPrimitiveComponentInterface = nullptr
 
FPrimitiveSceneInfoDataPrimitiveSceneData = nullptr
 
FPrimitiveSceneProxySceneProxy = nullptr
 
FPrimitiveComponentId LightingAttachmentComponentId
 
FPrimitiveComponentId LodParentComponentId
 
bool bShouldAddtoScene = true
 
bool bRecreateProxyOnUpdateTransform = false
 
bool bIsUnreachable = false
 
bool bBulkReregister = false
 
EComponentMobility::Type Mobility = EComponentMobility::Movable
 
FBoxSphereBounds Bounds
 
FBoxSphereBounds LocalBounds
 
FMatrix RenderMatrix
 
FVector AttachmentRootPosition
 
UObjectPrimitiveUObject = nullptr
 
UWorldWorld = nullptr
 

Detailed Description

FPrimitiveSceneDesc is a structure that can be used to Add/Remove/Update primitives in an FScene.

It encapsulates all the necessary information to create/update the primitive. Usage of an PrimitiveComponentInterface is optional, but if one is not provided the ProxyDesc must already be created and passed in the ProxyDesc member.

Member Function Documentation

◆ GetActorPositionForRenderer()

FVector FPrimitiveSceneDesc::GetActorPositionForRenderer ( )
inline

◆ GetAttachmentCounter()

FThreadSafeCounter * FPrimitiveSceneDesc::GetAttachmentCounter ( ) const
inline

◆ GetBounds()

FBoxSphereBounds FPrimitiveSceneDesc::GetBounds ( )
inline

◆ GetFullName()

FString FPrimitiveSceneDesc::GetFullName ( )
inline

◆ GetLastSubmitTime()

double FPrimitiveSceneDesc::GetLastSubmitTime ( )
inline

◆ GetLightingAttachmentId()

FPrimitiveComponentId FPrimitiveSceneDesc::GetLightingAttachmentId ( ) const
inline

◆ GetLocalBounds()

FBoxSphereBounds FPrimitiveSceneDesc::GetLocalBounds ( )
inline

◆ GetLODParentId()

FPrimitiveComponentId FPrimitiveSceneDesc::GetLODParentId ( ) const
inline

◆ GetMobility()

EComponentMobility::Type FPrimitiveSceneDesc::GetMobility ( )
inline

◆ GetName()

FString FPrimitiveSceneDesc::GetName ( )
inline

◆ GetOutermost()

UPackage * FPrimitiveSceneDesc::GetOutermost ( ) const
inline

◆ GetPrimitiveComponentInterface() [1/2]

IPrimitiveComponent * FPrimitiveSceneDesc::GetPrimitiveComponentInterface ( )
inline

◆ GetPrimitiveComponentInterface() [2/2]

const IPrimitiveComponent * FPrimitiveSceneDesc::GetPrimitiveComponentInterface ( ) const
inline

◆ GetPrimitiveSceneId()

FPrimitiveComponentId FPrimitiveSceneDesc::GetPrimitiveSceneId ( ) const
inline

◆ GetRenderMatrix() [1/2]

FMatrix FPrimitiveSceneDesc::GetRenderMatrix ( )
inline

◆ GetRenderMatrix() [2/2]

const FMatrix & FPrimitiveSceneDesc::GetRenderMatrix ( ) const
inline

◆ GetSceneData()

FPrimitiveSceneInfoData & FPrimitiveSceneDesc::GetSceneData ( )
inline

◆ GetSceneProxy()

FPrimitiveSceneProxy * FPrimitiveSceneDesc::GetSceneProxy ( ) const
inline

◆ GetSceneProxyDesc()

FPrimitiveSceneProxyDesc * FPrimitiveSceneDesc::GetSceneProxyDesc ( )
inline

◆ GetWorld()

UWorld * FPrimitiveSceneDesc::GetWorld ( )
inline

◆ IsUnreachable()

bool FPrimitiveSceneDesc::IsUnreachable ( )
inline

◆ ReleaseSceneProxy()

void FPrimitiveSceneDesc::ReleaseSceneProxy ( )
inline

◆ SetLastSubmitTime()

void FPrimitiveSceneDesc::SetLastSubmitTime ( double  InSubmitTime)
inline

◆ SetLightingAttachmentId()

void FPrimitiveSceneDesc::SetLightingAttachmentId ( FPrimitiveComponentId  Id)
inline

◆ SetLODParentId()

void FPrimitiveSceneDesc::SetLODParentId ( FPrimitiveComponentId  Id)
inline

◆ ShouldRecreateProxyOnUpdateTransform()

bool FPrimitiveSceneDesc::ShouldRecreateProxyOnUpdateTransform ( )
inline

Member Data Documentation

◆ AttachmentRootPosition

FVector FPrimitiveSceneDesc::AttachmentRootPosition

◆ bBulkReregister

bool FPrimitiveSceneDesc::bBulkReregister = false

◆ bIsUnreachable

bool FPrimitiveSceneDesc::bIsUnreachable = false

◆ Bounds

FBoxSphereBounds FPrimitiveSceneDesc::Bounds

◆ bRecreateProxyOnUpdateTransform

bool FPrimitiveSceneDesc::bRecreateProxyOnUpdateTransform = false

◆ bShouldAddtoScene

bool FPrimitiveSceneDesc::bShouldAddtoScene = true

◆ LightingAttachmentComponentId

FPrimitiveComponentId FPrimitiveSceneDesc::LightingAttachmentComponentId

◆ LocalBounds

FBoxSphereBounds FPrimitiveSceneDesc::LocalBounds

◆ LodParentComponentId

FPrimitiveComponentId FPrimitiveSceneDesc::LodParentComponentId

◆ Mobility

EComponentMobility::Type FPrimitiveSceneDesc::Mobility = EComponentMobility::Movable

◆ PrimitiveComponentInterface

IPrimitiveComponent* FPrimitiveSceneDesc::PrimitiveComponentInterface = nullptr

◆ PrimitiveSceneData

FPrimitiveSceneInfoData* FPrimitiveSceneDesc::PrimitiveSceneData = nullptr

◆ PrimitiveUObject

UObject* FPrimitiveSceneDesc::PrimitiveUObject = nullptr

◆ ProxyDesc

FPrimitiveSceneProxyDesc* FPrimitiveSceneDesc::ProxyDesc = nullptr

◆ RenderMatrix

FMatrix FPrimitiveSceneDesc::RenderMatrix

◆ SceneProxy

FPrimitiveSceneProxy* FPrimitiveSceneDesc::SceneProxy = nullptr

◆ World

UWorld* FPrimitiveSceneDesc::World = nullptr

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