Navigation
API > API/Plugins > API/Plugins/DisplayCluster
A label component specific to nDisplay. Displays a widget with a consistent scale facing the root actor view point. Visible only in scene capture when in the editor or in 3d space on the wall.
The component needs to be transient so its settings aren't saved, but should still transact over multi-user.
| Name | UDisplayClusterLabelComponent |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Components/DisplayClusterLabelComponent.h |
| Include Path | #include "Components/DisplayClusterLabelComponent.h" |
Syntax
UCLASS (Transient, Meta=(BlueprintSpawnableComponent, DisplayClusterMultiUserInclude))
class UDisplayClusterLabelComponent : public USceneComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UDisplayClusterLabelComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDisplayClusterLabelComponent() |
Components/DisplayClusterLabelComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LabelFlags | EDisplayClusterLabelFlags | Current flags set for this label component | Components/DisplayClusterLabelComponent.h | |
| RootActor | TWeakObjectPtr< ADisplayClusterRootActor > | The root actor this label needs to know about | Components/DisplayClusterLabelComponent.h | |
| WidgetClass | TSoftClassPtr< UDisplayClusterLabelWidget > | The widget class to apply to the widget component | Components/DisplayClusterLabelComponent.h |
|
| WidgetComponent | TObjectPtr< UDisplayClusterWidgetComponent > | The widget component to display for this label | Components/DisplayClusterLabelComponent.h |
|
| WidgetScale | float | A uniform scale to apply to the text which will keep consistency across distance from the label to the root actor view | Components/DisplayClusterLabelComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearLabelFlags
(
EDisplayClusterLabelFlags InFlags |
Clears all label flags | Components/DisplayClusterLabelComponent.h | |
EDisplayClusterLabelFlags GetLabelFlags() |
Retrieve label flags | Components/DisplayClusterLabelComponent.h | |
UWidgetComponent * GetWidgetComponent() |
Returns the widget component | Components/DisplayClusterLabelComponent.h | |
float GetWidgetScale() |
Return the widget scale | Components/DisplayClusterLabelComponent.h | |
bool HasAnyLabelFlags
(
EDisplayClusterLabelFlags InFlags |
Checks for existence of a flag on this label | Components/DisplayClusterLabelComponent.h | |
void SetLabelConfiguration
(
const FDisplayClusterLabelConfiguration& InConfiguration |
Set the configuration for this label updating multiple properties at once | Components/DisplayClusterLabelComponent.h | |
void SetLabelFlags
(
EDisplayClusterLabelFlags InFlags |
Updates flags for this label | Components/DisplayClusterLabelComponent.h | |
void SetRootActor
(
ADisplayClusterRootActor* InActor |
Set the root actor this label should use when determining transform | Components/DisplayClusterLabelComponent.h | |
void SetWidgetScale
(
float NewValue |
Set the widget scale | Components/DisplayClusterLabelComponent.h |
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRegister() |
Components/DisplayClusterLabelComponent.h | ||
virtual void TickComponent
(
float DeltaTime, |
Components/DisplayClusterLabelComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Components/DisplayClusterLabelComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CheckForVisibilityChange() |
Verify the widget visibility matches this component's visibility | Components/DisplayClusterLabelComponent.h | |
void UpdateWidgetComponent() |
Updates the widget component text and transform | Components/DisplayClusterLabelComponent.h |