Navigation
API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- USceneComponent
- UDisplayClusterCameraComponent
- UDisplayClusterInFrustumFitCameraComponent
References
| Module | DisplayCluster |
| Header | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Components/DisplayClusterCameraComponent.h |
| Include | #include "Components/DisplayClusterCameraComponent.h" |
Syntax
UCLASS (ClassGroup=(DisplayCluster),
HideCategories=(Navigation, AssetUserData, LOD, Physics, Cooking, Activation, Tags, Gizmo, Collision, ComponentReplication, Events, Sockets, ComponentTick),
Meta=(BlueprintSpawnableComponent, DisplayName="NDisplay View Origin"))
class UDisplayClusterCameraComponent :
public USceneComponent ,
public IDisplayClusterComponent
Remarks
3D point in space used to render nDisplay viewports from
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
FVector | BaseGizmoScale | Base gizmo scale |
   |
uint8: 1 | bEnableGizmo | Gizmo visibility |
   |
float | GizmoScaleMultiplier | Gizmo scale multiplier |
   |
TObjectPtr< UBillboardComponent > | SpriteComponent | |
  |
TObjectPtr< UTexture2D > | SpriteTexture |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UDisplayClusterCameraComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | GetDesiredView
(
IDisplayClusterViewportConfiguration& InViewportConfiguration, |
Return ViewPoint for this component If the component logic supports postprocess, it will also be in the ViewInfo structure. |
  |
void | GetDesiredView
(
FMinimalViewInfo& InOutViewInfo, |
Return ViewPoint for this component If the component logic supports postprocess, it will also be in the ViewInfo structure. |
   |
TObjectPtr< UMaterial > | GetDisplayDeviceMaterial
(
const EDisplayClusterDisplayDeviceMeshType InMeshType, |
Override DisplayDevice material by type for The UDisplayClusterInFrustumFitCameraComponent uses its own material to display additional deformed preview meshes in front of the camera. |
    |
float | Get interpupillary distance | |
    |
EDisplayClusterEyeStereoOffset | Get stereo offset type | |
    |
bool | GetSwapEyes () |
Get swap eyes state |
  |
IDisplayClusterWarpPolicy * | GetWarpPolicy
(
IDisplayClusterViewportManager* InViewportManager |
Get the warp policy instance used by this compoenent. |
   |
void | OnUpdateDisplayDeviceMeshAndMaterialInstance
(
IDisplayClusterViewportPreview& InViewportPreview, |
Perform any operations on the mesh and material instance, such as setting parameter values. |
  |
void | Refreshes the visual components to match the component state | |
   |
void | SetInterpupillaryDistance
(
float Distance |
Set interpupillary distance |
   |
void | SetStereoOffset
(
EDisplayClusterEyeStereoOffset InStereoOffset |
Set stereo offset type |
   |
void | SetSwapEyes
(
bool SwapEyes |
Set swap eyes state |
   |
bool | ShouldUseEntireClusterViewports
(
IDisplayClusterViewportManager* InViewportManager |
All cluster viewports that reference this component will be created in the background on the current cluster node if the function returns true. |
   |
bool | Toggles eyes swap state |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnRegister () |
End IDisplayClusterComponent. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Begin UObject. |
Overridden from IDisplayClusterComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | SetVisualizationEnabled
(
bool bEnabled |
Activates or deactivates component visualization |
  |
void | SetVisualizationScale
(
float Scale |
Begin IDisplayClusterComponent. |