1. Epic GamesDeveloper
  3. UDisplayClusterStageGeometryComponent

UDisplayClusterStageGeometryComponent

A component that stores the generated geometry map of the stage actor, which is used for placing stage actors (light cards, CCWs, etc) flush to the stage's walls and ceiling

API > API/Plugins > API/Plugins/DisplayCluster

A component that stores the generated geometry map of the stage actor, which is used for placing stage actors (light cards, CCWs, etc) flush to the stage's walls and ceiling

   
Name UDisplayClusterStageGeometryComponent
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Components/DisplayClusterStageGeometryComponent.h
Include Path #include "Components/DisplayClusterStageGeometryComponent.h"

Syntax

UCLASS ()  
class UDisplayClusterStageGeometryComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UDisplayClusterStageGeometryComponent()

   Components/DisplayClusterStageGeometryComponent.h  

Constants

Name Type Remarks Include Path
GeometryMapFOV const float The field of view to render the geometry map with Components/DisplayClusterStageGeometryComponent.h
GeometryMapSize const uint32 The default size of the geometry map texture Components/DisplayClusterStageGeometryComponent.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bGeometryMapLoaded bool Indicates that the resources for the geometry map have been loaded Components/DisplayClusterStageGeometryComponent.h  
bUpdateGeometryMap bool Indicates that the geometry map should be updated on the next tick Components/DisplayClusterStageGeometryComponent.h  
NorthGeometryMap FDisplayClusterStageGeometryMap The cached geometry map for the stage's northern hemisphere Components/DisplayClusterStageGeometryComponent.h
  • Transient
Renderer TSharedPtr< FDisplayClusterMeshProjectionRenderer > The renderer used to generate the stage's geometry map Components/DisplayClusterStageGeometryComponent.h  
SouthGeometryMap FDisplayClusterStageGeometryMap The cached geometry map for the stage's southern hemisphere Components/DisplayClusterStageGeometryComponent.h
  • Transient
StageBoundingRadius float The cached bounding radius of the stage's geometry Components/DisplayClusterStageGeometryComponent.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetStageBoundingRadius()

 Gets the bounding radius of the stage's geometry Components/DisplayClusterStageGeometryComponent.h
  • BlueprintGetter
  • Category="NDisplay"

bool GetStageDistanceAndNormal ( const FVector& InDirection,
float& OutDistance,
FVector& OutNormal
)

 Gets the distance and normal vector (in radial space) of the stage's geometry in the specified world direction Components/DisplayClusterStageGeometryComponent.h
  • BlueprintCallable
  • Category="NDisplay"

void Invalidate ( bool bForceImmediateRedraw
)

 Invalidates and regenerates the cached stage geometry map Components/DisplayClusterStageGeometryComponent.h
  • BlueprintCallable
  • Category="NDisplay"

bool IsGeometryMapValid()

 Gets whether the stage geometry map is valid and usable Components/DisplayClusterStageGeometryComponent.h
  • BlueprintCallable
  • Category="NDisplay"

bool MorphProceduralMesh ( UProceduralMeshComponent* InProceduralMeshComponent,
bool bSyncMeshLocation
)

 Morphs the specified procedural mesh to match the stage's geometry map Components/DisplayClusterStageGeometryComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   Components/DisplayClusterStageGeometryComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page