1. Epic GamesDeveloper
  3. UDisplayClusterICVFXCameraComponent

UDisplayClusterICVFXCameraComponent

NDisplay in-camera VFX camera representation

API > API/Plugins > API/Plugins/DisplayCluster

NDisplay in-camera VFX camera representation

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

Syntax

UCLASS (ClassGroup=(DisplayCluster),  
       HideCategories=(AssetUserData, Collision, Cooking, ComponentReplication, Events, Physics, Sockets, Activation, Tags, ComponentTick),  
       Meta=(BlueprintSpawnableComponent, DisplayName="ICVFX Camera"))  
class UDisplayClusterICVFXCameraComponent : public UCineCameraComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UDisplayClusterICVFXCameraComponent ( const FObjectInitializer& ObjectInitializer
)

   Components/DisplayClusterICVFXCameraComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CameraSettings FDisplayClusterConfigurationICVFX_CameraSettings   Components/DisplayClusterICVFXCameraComponent.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=NDisplay
ExternalCameraCachedValue TSoftObjectPtr< ACineCameraActor > Saves the value of external camera reference Components/DisplayClusterICVFXCameraComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AllNodesColorGradingRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum Color Grading"
  • Meta=(PropertyPath="CameraSettings.AllNodesColorGrading", DisplayName="All Nodes")
AllNodesOCIOConfigurationRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CameraSettings.CameraOCIO.AllNodesOCIOConfiguration.ColorConfiguration", DisplayName="All Nodes Color Configuration")
BorderRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.Border")
BufferRatioRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.BufferRatio")
CameraDepthOfFieldRef FDisplayClusterEditorPropertyReference Exposed reference to the camera's inner depth of field settings Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Camera ICVFX"
  • Meta=(PropertyPath="CameraSettings.CameraDepthOfField", DisplayName="ICVFX Depth of Field")
CameraHideListRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.CameraHideList")
CameraMotionBlurRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Camera ICVFX"
  • Meta=(PropertyPath="CameraSettings.CameraMotionBlur", DisplayName="ICVFX Camera Motion Blur")
ChromakeyColorRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.ChromakeyColor")
ChromaKeyEnabledRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.bEnable")
ChromakeyMarkersRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.ChromakeyMarkers")
ChromakeyRenderTextureRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.ChromakeyRenderTexture")
ChromakeySettingsSourceRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.ChromakeySettingsSource")
ChromakeyTypeRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Chromakey
  • Meta=(PropertyPath="CameraSettings.Chromakey.ChromakeyType")
CustomFrameSizeRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.CustomFrameSize")
CustomFrustumRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(DisplayName="Inner Frustum Overscan", PropertyPath="CameraSettings.CustomFrustum")
EnableInnerFrustumColorGrading FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum Color Grading"
  • Meta=(PropertyPath="CameraSettings.EnableInnerFrustumColorGrading", DisplayName="Enable Inner Frustum Color Grading")
EnableInnerFrustuOCIORef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CameraSettings.CameraOCIO.AllNodesOCIOConfiguration.bIsEnabled", DisplayName="Enable Inner Frustum OCIO")
ExternalCameraActorRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Camera ICVFX"
  • Meta=(PropertyPath="CameraSettings.ExternalCameraActor")
FrustumOffsetRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.FrustumOffset")
FrustumRotationRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.FrustumRotation")
GenerateMipsRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.GenerateMips")
GPUIndexRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.AdvancedRenderSettings.GPUIndex")
HiddenICVFXViewportsRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.HiddenICVFXViewports")
IsEnabledRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.bEnable")
MediaRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditDefaultsOnly
  • Transient
  • Category="Media"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.Media")
OffCenterProjectionOffsetRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.OffCenterprojectionoffset")
PerNodeColorGradingRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum Color Grading"
  • Meta=(PropertyPath="CameraSettings.PerNodeColorGrading")
PerNodeOCIOProfilesRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=OCIO
  • Meta=(PropertyPath="CameraSettings.CameraOCIO.PerNodeOCIOProfiles", DisplayName="Per-Node OCIO Overrides")
RenderOrderRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.RenderOrder")
RenderTargetRatioRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.AdvancedRenderSettings.RenderTargetRatio")
ShouldUseTextureRegionRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Texture Replacement"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.Replace.bShouldUseTextureRegion")
SoftEdgeRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.SoftEdge")
SourceTextureRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Texture Replacement"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.Replace.SourceTexture")
StereoGPUIndexRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.AdvancedRenderSettings.StereoGPUIndex")
StereoModeRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category=Configuration
  • Meta=(PropertyPath="CameraSettings.RenderSettings.AdvancedRenderSettings.StereoMode")
TextureRegionRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Texture Replacement"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.Replace.TextureRegion")
TextureReplacementEnabledRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Texture Replacement"
  • Meta=(PropertyPath="CameraSettings.RenderSettings.Replace.bAllowReplace", DisplayName="Enable Inner Frustum Texture Replacement", ToolTip="Set to True to replace the entire inner frustum with the specified texture.")
UpscalerSettingsRef FDisplayClusterEditorPropertyReference   Components/DisplayClusterICVFXCameraComponent.h
  • EditAnywhere
  • Transient
  • Category="Inner Frustum"
  • Meta=(PropertyPath="CameraSettings.UpscalerSettings")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ApplyICVFXCameraPostProcessesToViewport ( IDisplayClusterViewport* InDestViewport,
const EDisplayClusterViewportCameraPostProcessFlags InPostProcessingFlags
)

 The ICVFXCamera component uses its own PostProcess and applies it to the viewport. Components/DisplayClusterICVFXCameraComponent.h  
Return the actual source camera, e.g. the camera component of the referenced cine camera. Components/DisplayClusterICVFXCameraComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="ICVFX Camera"

const FDisplayClusterConfigurationICVFX_CameraSettings & GetCameraSettingsICVFX()

   Components/DisplayClusterICVFXCameraComponent.h  

FString GetCameraUniqueId()

 Return unique camera name. Components/DisplayClusterICVFXCameraComponent.h  

virtual TSharedPtr< SWidget > GetCustomEditorPreviewWidget()

   Components/DisplayClusterICVFXCameraComponent.h  

virtual bool GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

   Components/DisplayClusterICVFXCameraComponent.h  

FIntPoint GetICVFXCameraFrameSize ( const FDisplayClusterConfigurationICVFX_StageSettings& InStageSettings,
const FDisplayClusterConfigurationICVFX_CameraSettings& InCameraSettings
)

 Get ICVFX camera frame resolution. Components/DisplayClusterICVFXCameraComponent.h  

FDisplayClusterShaderParameters_ICVFX::FCameraSettings GetICVFXCameraShaderParameters ( const FDisplayClusterConfigurationICVFX_StageSettings& InStageSettings,
const FDisplayClusterConfigurationICVFX_CameraSettings& InCameraSettings
)

 Get ICVFX camera shader parameters. Components/DisplayClusterICVFXCameraComponent.h  

FDisplayClusterViewport_CameraMotionBlur GetMotionBlurParameters()

   Components/DisplayClusterICVFXCameraComponent.h  

bool IsICVFXEnabled()

 Returns true if this camera is active in the current node. Components/DisplayClusterICVFXCameraComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="ICVFX Camera"

virtual void PostApplyToComponent()

   Components/DisplayClusterICVFXCameraComponent.h  

virtual void PostLoad()

   Components/DisplayClusterICVFXCameraComponent.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   Components/DisplayClusterICVFXCameraComponent.h  

void SetDepthOfFieldParameters ( const FDisplayClusterConfigurationICVFX_CameraDepthOfField& NewDepthOfFieldParams
)

 Sets new depth of field parameters and updates the dynamically generated compensation LUT if needed Components/DisplayClusterICVFXCameraComponent.h
  • BlueprintCallable
  • Category="ICVFX Camera"
Details Panel Property Referencers. Components/DisplayClusterICVFXCameraComponent.h  

Overridden from UCineCameraComponent

Name Remarks Include Path Unreal Specifiers

virtual void GetCameraView ( float DeltaTime,
FMinimalViewInfo& InOutViewInfo
)

 Obtaining view information for the actual camera, such as the camera component to which the cine-camera is referencing. Components/DisplayClusterICVFXCameraComponent.h  

virtual void OnRegister()

   Components/DisplayClusterICVFXCameraComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/DisplayClusterICVFXCameraComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/DisplayClusterICVFXCameraComponent.h  

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

   Components/DisplayClusterICVFXCameraComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page