1. Epic GamesDeveloper
  3. UDisplayClusterCameraComponent

UDisplayClusterCameraComponent

3D point in space used to render nDisplay viewports from

API > API/Plugins > API/Plugins/DisplayCluster

3D point in space used to render nDisplay viewports from

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

Syntax

UCLASS (ClassGroup=(DisplayCluster),  
       HideCategories=(Navigation, AssetUserData, LOD, Physics, Cooking, Activation, Tags, Gizmo, Collision, ComponentReplication, Events, Sockets, ComponentTick, Rendering),  
       Meta=(BlueprintSpawnableComponent, DisplayName="NDisplay View Point"))  
class UDisplayClusterCameraComponent :  
    public USceneComponent ,  
    public IDisplayClusterComponent

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UDisplayClusterCameraComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/DisplayClusterCameraComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnableDepthOfField uint8 Enable the DoF PP settings from the specified camera. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Depth Of Field", EditCondition="TargetCameraType!=EDisplayClusterTargetCameraType::None && TargetCameraType!=EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
bEnableICVFXColorGrading uint8 Use the DC ColorGrading from the specified ICVFX camera. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Inner Frustum Color Grading", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
bEnableICVFXDepthOfFieldCompensation uint8 Use the DC Depth-Of-Field settings from the specified ICVFX camera. Components/DisplayClusterCameraComponent.h
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Inner Frustum Depth Of Field Compensation", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
bEnableICVFXMotionBlur uint8 Use the DC Motion Blur settings from the specified ICVFX camera. Components/DisplayClusterCameraComponent.h
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Inner Frustum Motion Blur", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
bEnableNearClippingPlane uint8 Use the NearClippingPlane value from the specified cine camera. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Custom Near Clipping Plane", EditCondition="TargetCameraType!=EDisplayClusterTargetCameraType::None && TargetCameraType!=EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
bEnablePostProcess uint8 Use the PP settings from the specified camera. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Include Post Process Settings", EditCondition="TargetCameraType!=EDisplayClusterTargetCameraType::None", EditConditionHides)
bFollowCameraPosition uint8 Use camera position for rendering instead of RootActor. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Follow Camera", EditCondition="TargetCameraType!=EDisplayClusterTargetCameraType::ICVFXCameraComponent && TargetCameraType!=EDisplayClusterTargetCameraType::None", EditConditionHides)
bUseICVFXCameraComponentTracking uint8   Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Follow ICVFX Camera", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
ExternalCineCameraActor TSoftObjectPtr< ACineCameraActor > Use a specific actor camera instead of a game camera. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Camera Actor", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ExternalCineCameraActor", EditConditionHides)
ICVFXCameraComponentName FString The name of the camera component that is used as the PP source. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="ICVFX Camera", EditCondition="TargetCameraType==EDisplayClusterTargetCameraType::ICVFXCameraComponent", EditConditionHides)
TargetCameraType EDisplayClusterTargetCameraType Type of source camera used. Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Camera Settings"
  • Meta=(DisplayName="Source Camera")

Protected

Name Type Remarks Include Path Unreal Specifiers
bSwapEyes bool   Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • Category="Stereo"
InterpupillaryDistance float   Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • Category="Stereo"
StereoOffset EDisplayClusterEyeStereoOffset   Components/DisplayClusterCameraComponent.h
  • EditAnywhere
  • Category="Stereo"

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ApplyViewPointComponentPostProcessesToViewport ( IDisplayClusterViewport* InViewport
)

 Apply the ViewPoint component's post-processes to the viewport. (Outer viewport camera) Components/DisplayClusterCameraComponent.h  

virtual bool CanOverrideEyePosition()

 Returns true if the eye position (ViewPoint) inside the DCRa can be overriden. Components/DisplayClusterCameraComponent.h  

EDisplayClusterViewportCameraPostProcessFlags GetCameraPostProcessFlags()

 Decodes parameters into flags. Components/DisplayClusterCameraComponent.h  

virtual void GetDesiredView ( FMinimalViewInfo& InOutViewInfo,
float* OutCustomNearClippingPlane
)

 Return ViewPoint for this component If the component logic supports postprocess, it will also be in the ViewInfo structure. Components/DisplayClusterCameraComponent.h  

virtual void GetDesiredView ( const IDisplayClusterViewportConfiguration& InViewportConfiguration,
FMinimalViewInfo& InOutViewInfo,
float* OutCustomNearClippingPlane
) const

 Return ViewPoint for this component If the component logic supports postprocess, it will also be in the ViewInfo structure. Components/DisplayClusterCameraComponent.h  

virtual TObjectPtr< UMaterial > GetDisplayDeviceMaterial ( const EDisplayClusterDisplayDeviceMeshType InMeshType,
const EDisplayClusterDisplayDeviceMaterialType InMaterialType
) const

 Override DisplayDevice material by type for The UDisplayClusterInFrustumFitCameraComponent uses its own material to display additional deformed preview meshes in front of the camera. Components/DisplayClusterCameraComponent.h  

virtual UCameraComponent * GetExternalCineCameraActorComponent()

 Returns the camera component from the 'ExternalCameraActor' parameter. Components/DisplayClusterCameraComponent.h  

virtual void GetEyePosition ( const IDisplayClusterViewportConfiguration& InViewportConfiguration,
FVector& OutViewLocation,
FRotator& OutViewRotation
)

 Returns the position of the observer's eyes in the Stage. Components/DisplayClusterCameraComponent.h  

float GetInterpupillaryDistance()

 Get interpupillary distance Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

EDisplayClusterEyeStereoOffset GetStereoOffset()

 Get stereo offset type Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

bool GetSwapEyes()

 Get swap eyes state Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

virtual UCameraComponent * GetTargetCameraComponent ( const IDisplayClusterViewportConfiguration& InViewportConfiguration
) const

 Return a reference to the Camera component, which is used for Outer viewports. Components/DisplayClusterCameraComponent.h  
Get the warp policy instance used by this compoenent. Components/DisplayClusterCameraComponent.h  

virtual bool IsViewPointOverrideCameraPosition()

 Returns true if the given viewpoint position should be used as a camera position. Components/DisplayClusterCameraComponent.h  

virtual void OnUpdateDisplayDeviceMeshAndMaterialInstance ( IDisplayClusterViewportPreview& InViewportPreview,
const EDisplayClusterDisplayDeviceMeshType InMeshType,
const EDisplayClusterDisplayDeviceMaterialType InMaterialType,
UMeshComponent* InMeshComponent,
UMaterialInstanceDynamic* InMeshMaterialInstance
) const

 Perform any operations on the mesh and material instance, such as setting parameter values. Components/DisplayClusterCameraComponent.h  

void SetInterpupillaryDistance ( float Distance
)

 Set interpupillary distance Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

void SetStereoOffset ( EDisplayClusterEyeStereoOffset InStereoOffset
)

 Set stereo offset type Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

void SetSwapEyes ( bool SwapEyes
)

 Set swap eyes state Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

virtual bool ShouldFollowCameraLocation()

 Returns true if ViewPoint should use the camera position instead of the DCRA position when transforming. Components/DisplayClusterCameraComponent.h  

virtual bool ShouldUseEntireClusterViewports ( IDisplayClusterViewportManager* InViewportManager
) const

 All cluster viewports that reference this component will be created in the background on the current cluster node if the function returns true. Components/DisplayClusterCameraComponent.h  

bool ToggleSwapEyes()

 Toggles eyes swap state Components/DisplayClusterCameraComponent.h
  • BlueprintCallable
  • Category="Stereo"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnRegister()

 End IDisplayClusterComponent. Components/DisplayClusterCameraComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

 Begin UObject. Components/DisplayClusterCameraComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/DisplayClusterCameraComponent.h  

Overridden from IDisplayClusterComponent

Name Remarks Include Path Unreal Specifiers

virtual void SetVisualizationEnabled ( bool bEnabled
)

 Activates or deactivates component visualization Components/DisplayClusterCameraComponent.h  

virtual void SetVisualizationScale ( float Scale
)

 Begin IDisplayClusterComponent. Components/DisplayClusterCameraComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual UCameraComponent * GetEditorPreviewCameraComponent()

 Return used camera component. Components/DisplayClusterCameraComponent.h  

virtual bool GetTargetCameraDesiredViewInternal ( const IDisplayClusterViewportConfiguration& InViewportConfiguration,
FMinimalViewInfo& InOutViewInfo,
float* OutCustomNearClippingPlane
) const

 Get view from the referenced camera. Components/DisplayClusterCameraComponent.h  

virtual bool IsActiveEngineCameraBeingUsed()

 Returns true if active engine camera is used. Components/DisplayClusterCameraComponent.h  

virtual bool IsExternalCameraBeingUsed()

 Returns true if the `ExternalCineCameraActor_ parameter is used. Components/DisplayClusterCameraComponent.h  

virtual bool IsICVFXCameraBeingUsed()

 Returns true if the `ICVFXCameraComponentName_ parameter is used. Components/DisplayClusterCameraComponent.h  

virtual void RefreshVisualRepresentation()

 Refreshes the visual components to match the component state Components/DisplayClusterCameraComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< SWidget > GetCustomEditorPreviewWidget()

   Components/DisplayClusterCameraComponent.h  

virtual bool GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

   Components/DisplayClusterCameraComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page