1. Epic GamesDeveloper
  3. UDisplayClusterCameraComponent

UDisplayClusterCameraComponent

3D point in space used to render nDisplay viewports from

API > API/Plugins > API/Plugins/DisplayCluster > API/Plugins/DisplayCluster/Components

Inheritance Hierarchy

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, Rendering),  
       Meta=(BlueprintSpawnableComponent, DisplayName="NDisplay View Point"))  
class UDisplayClusterCameraComponent :  
    public USceneComponent ,  
    public IDisplayClusterComponent

Remarks

3D point in space used to render nDisplay viewports from

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere FVector BaseGizmoScale Base gizmo scale
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = 1 bEnableDepthOfField Enable the DoF PP settings from the specified camera.
Protected variable UProperty Category, EditAnywhere uint8: 1 bEnableGizmo Gizmo visibility
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = 1 bEnableICVFXColorGrading Use the DC ColorGrading from the specified ICVFX camera.
Public variable UProperty Category, Meta BlueprintReadWrite uint8: 1 = 1 bEnableICVFXDepthOfFieldCompensation Use the DC Depth-Of-Field settings from the specified ICVFX camera.
Public variable UProperty Category, Meta BlueprintReadWrite uint8: 1 = 1 bEnableICVFXMotionBlur Use the DC Motion Blur settings from the specified ICVFX camera.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = 1 bEnableNearClippingPlane Use the NearClippingPlane value from the specified cine camera.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = 1 bEnablePostProcess Use the PP settings from the specified camera.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 = 1 bUseICVFXCameraComponentTracking  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TSoftObjectPtr< ACineCameraActor > ExternalCineCameraActor Use a specific actor camera instead of a game camera.
Protected variable UProperty Category, EditAnywhere, Meta float GizmoScaleMultiplier Gizmo scale multiplier
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString ICVFXCameraComponentName The name of the camera component that is used as the PP source.
Protected variable UProperty Transient TObjectPtr< UBillboardComponent > SpriteComponent  
Protected variable UProperty TObjectPtr< UTexture2D > SpriteTexture  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EDisplayClusterTargetCameraType TargetCameraType Type of source camera used.

Constructors

  Type Name Description
Public function  

UDisplayClusterCameraComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void Apply the ViewPoint component's post-processes to the viewport. (Outer viewport camera)
Public function Const EDisplayClusterViewportCameraPostProcessFlags Decodes parameters into flags.
Public function 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.
Public function Virtual void

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

 Return ViewPoint for this component If the component logic supports postprocess, it will also be in the ViewInfo structure.
Public function Virtual Const TObjectPtr< UMaterial > Override DisplayDevice material by type for The UDisplayClusterInFrustumFitCameraComponent uses its own material to display additional deformed preview meshes in front of the camera.
Protected function Virtual UCameraComponent * Return used camera component.
Public function Virtual Const UCameraComponent * Returns the camera component from the 'ExternalCameraActor' parameter.
Public function Virtual void

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

 Returns the position of the observer's eyes in the Stage.
Public function Const UFunction BlueprintCallable, Category float Get interpupillary distance
Public function Const UFunction BlueprintCallable, Category EDisplayClusterEyeStereoOffset Get stereo offset type
Public function Const UFunction BlueprintCallable, Category bool Get swap eyes state
Public function Virtual Const UCameraComponent * Return a reference to the Camera component, which is used for Outer viewports.
Protected function Virtual Const bool

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

 Get view from the referenced camera.
Public function Virtual IDisplayClusterWarpPolicy * Get the warp policy instance used by this compoenent.
Protected function Virtual Const bool Returns true if active engine camera is used.
Protected function Virtual Const bool Returns true if the `ExternalCineCameraActor_ parameter is used.
Protected function Virtual Const bool Returns true if the `ICVFXCameraComponentName_ parameter is used.
Public function Virtual Const bool Returns true if the given viewpoint position should be used as a camera position.
Public function Virtual Const void Perform any operations on the mesh and material instance, such as setting parameter values.
Protected function Virtual void Refreshes the visual components to match the component state
Public function UFunction BlueprintCallable, Category void

SetInterpupillaryDistance ( float Distance
)

 Set interpupillary distance
Public function UFunction BlueprintCallable, Category void Set stereo offset type
Public function UFunction BlueprintCallable, Category void

SetSwapEyes ( bool SwapEyes
)

 Set swap eyes state
Public function Virtual Const bool All cluster viewports that reference this component will be created in the background on the current cluster node if the function returns true.
Public function UFunction BlueprintCallable, Category bool Toggles eyes swap state

Overridden from UActorComponent

  Type Name Description
Protected function Virtual TSharedPtr< SWidget > If this component is set up to provide a preview window in editor (see GetEditorPreviewInfo), you can use this to customize the preview (to be something other than a world viewport).
Protected function Virtual bool

GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

 Supplies the editor with a view specific to this component (think a view from a camera components POV, a render, etc.).
Public function Virtual void End IDisplayClusterComponent.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Begin UObject.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Overridden from IDisplayClusterComponent

  Type Name Description
Public function Virtual void

SetVisualizationEnabled ( bool bEnabled
)

 Activates or deactivates component visualization
Public function Virtual void

SetVisualizationScale ( float Scale
)

 Begin IDisplayClusterComponent.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page