1. Epic GamesDeveloper
  3. UMixedRealityCaptureComponent

UMixedRealityCaptureComponent

API > API/Plugins > API/Plugins/MixedRealityCaptureFramework

   
Name UMixedRealityCaptureComponent
Type class
Header File /Engine/Plugins/Runtime/MixedRealityCaptureFramework/Source/MixedRealityCaptureFramework/Public/MixedRealityCaptureComponent.h
Include Path #include "MixedRealityCaptureComponent.h"

Syntax

UCLASS (ClassGroup=Rendering, EditInlineNew, Blueprintable, BlueprintType, Config=Engine,  
       Meta=(BlueprintSpawnableComponent))  
class UMixedRealityCaptureComponent : public USceneCaptureComponent2D

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMixedRealityCaptureComponent ( const FObjectInitializer& ObjectInitializer
)

   MixedRealityCaptureComponent.h  

Classes

Name Remarks
FMRCaptureFeedOpenedDelegate  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutoLoadConfiguration bool Determines if this component should attempt to load the default MR calibration file on initialization MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Config
  • Category=Calibration
bProjectionDepthTracking bool Enabled by default, the projection plane tracks with the HMD to simulate the depth of the player. MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Config
  • BlueprintSetter=SetEnableProjectionDepthTracking
  • Category=Tracking
CaptureFeedRef FMrcVideoCaptureFeedIndex   MixedRealityCaptureComponent.h
  • BlueprintReadWrite
  • BlueprintSetter=SetCaptureDevice
  • Category=Composition
GarbageMatteCaptureTextureTarget TObjectPtr< UTextureRenderTarget2D >   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Composition
LensDistortionParameters FOpenCVLensDistortionParameters   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetLensDistortionParameters
  • Category=VideoCapture
MediaSource TObjectPtr< UMediaPlayer >   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=VideoCapture
OnCaptureSourceOpened FMRCaptureFeedOpenedDelegate   MixedRealityCaptureComponent.h
  • BlueprintAssignable
  • Category=VideoCapture
ProjectionDepthOffset float Depth offset (in UE units) for the card that the camera feed is projected onto. MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Config
  • BlueprintSetter=SetProjectionDepthOffset
  • Category=Composition
TrackingLatency int32 Millisecond delay to apply to motion controller components when rendering to the capture view (to better align with latent camera feeds) MixedRealityCaptureComponent.h
  • BlueprintReadWrite
  • Config
  • BlueprintGetter=GetTrackingDelay
  • BlueprintSetter=SetTrackingDelay
  • Category=Composition
  • Meta=(ClampMin="0", UIMin="0")
TrackingSourceName FName   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Tracking
VideoProcessingMaterial TObjectPtr< UMaterialInterface >   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetVidProjectionMat
  • Category=Composition
VideoProcessingParams FMrcVideoProcessingParams   MixedRealityCaptureComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetVidProcessingParams
  • Category=Composition

Protected

Name Type Remarks Include Path Unreal Specifiers
CalibratedFOV float   MixedRealityCaptureComponent.h  
DistortionDisplacementMap TObjectPtr< UTexture2D >   MixedRealityCaptureComponent.h
  • Transient
GarbageMatteCaptureComponent TObjectPtr< UMrcGarbageMatteCaptureComponent >   MixedRealityCaptureComponent.h
  • Transient
PairedTracker TObjectPtr< UMotionControllerComponent >   MixedRealityCaptureComponent.h
  • Transient
ProjectionActor TObjectPtr< UChildActorComponent >   MixedRealityCaptureComponent.h
  • Transient
ProxyMesh TObjectPtr< UStaticMesh >   MixedRealityCaptureComponent.h
  • Transient
ProxyMeshComponent TObjectPtr< UStaticMeshComponent >   MixedRealityCaptureComponent.h
  • Transient
RelativeOriginType EHMDTrackingOrigin::Type   MixedRealityCaptureComponent.h  
TrackingOriginOffset TObjectPtr< USceneComponent >   MixedRealityCaptureComponent.h
  • Transient
UndistortedCameraInfo FOpenCVCameraViewInfo   MixedRealityCaptureComponent.h  
ViewExtension TSharedPtr< FMrcLatencyViewExtension, ESPMode::ThreadSafe >   MixedRealityCaptureComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyCalibrationData ( UMrcCalibrationData* ConfigData
)

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="MixedRealityCapture|Calibration"

UMrcCalibrationData * ConstructCalibrationData()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • BlueprintNativeEvent
  • Category="MixedRealityCapture|Calibration"

void DetatchFromDevice()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Tracking"

void FillOutCalibrationData ( UMrcCalibrationData* Dst
) const

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"

AMrcProjectionActor * GetProjectionActor()

   MixedRealityCaptureComponent.h
  • BlueprintPure
  • Category="MixedRealityCapture|Projection"
  • Meta=(DisplayName="GetProjectionActor")

AActor * GetProjectionActor_K2()

   MixedRealityCaptureComponent.h
  • BlueprintPure
  • Category="MixedRealityCapture|Projection"
  • Meta=(DisplayName="GetProjectionActor")

int32 GetTrackingDelay()

   MixedRealityCaptureComponent.h
  • BlueprintGetter

bool IsTracked()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Tracking"

bool LoadConfiguration ( const FString& SlotName,
int32 UserIndex
)

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"

bool LoadDefaultConfiguration()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"

void RefreshCameraFeed()

   MixedRealityCaptureComponent.h  

void RefreshDevicePairing()

   MixedRealityCaptureComponent.h  

void RefreshTrackingOriginOffset()

   MixedRealityCaptureComponent.h  

bool SaveAsDefaultConfiguration()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"
  • Meta=(DisplayName="SaveAsDefaultConfiguration")

bool SaveAsDefaultConfiguration_K2()

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"
  • Meta=(DisplayName="SaveAsDefaultConfiguration")

bool SaveConfiguration ( const FString& SlotName,
int32 UserIndex
) const

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"
  • Meta=(DisplayName="SaveConfiguration")

bool SaveConfiguration_K2 ( const FString& SlotName,
int32 UserIndex
)

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Calibration"
  • Meta=(DisplayName="SaveConfiguration")

void SetCaptureDevice ( const FMrcVideoCaptureFeedIndex& FeedRef
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

void SetDeviceAttachment ( FName SourceName
)

   MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|Tracking"

void SetEnableProjectionDepthTracking ( bool bEnable
)

 Enabled by default, the projection plane tracks with the HMD to simulate the depth of the player. MixedRealityCaptureComponent.h
  • BlueprintSetter
Set an external garbage matte actor to be used instead of the mixed reality component's normal configuration save game based actor. MixedRealityCaptureComponent.h
  • BlueprintCallable
  • Category="MixedRealityCapture|GarbageMatting"

void SetLensDistortionParameters ( const FOpenCVLensDistortionParameters& ModelRef
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

void SetProjectionDepthOffset ( float DepthOffset
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

void SetTrackingDelay ( int32 DelayMS
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

void SetVidProcessingParams ( const FMrcVideoProcessingParams& NewVidProcessingParams
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

void SetVidProjectionMat ( UMaterialInterface* NewMaterial
)

   MixedRealityCaptureComponent.h
  • BlueprintSetter

Overridden from USceneCaptureComponent

Name Remarks Include Path Unreal Specifiers

virtual const AActor * GetViewOwner()

   MixedRealityCaptureComponent.h  

virtual void UpdateSceneCaptureContents ( FSceneInterface* Scene,
ISceneRenderBuilder& SceneRenderBuilder
)

   MixedRealityCaptureComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

   MixedRealityCaptureComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void Activate ( bool bReset
)

   MixedRealityCaptureComponent.h  

virtual void Deactivate()

   MixedRealityCaptureComponent.h  

virtual bool GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

   MixedRealityCaptureComponent.h  

virtual void InitializeComponent()

   MixedRealityCaptureComponent.h  

virtual void OnComponentDestroyed ( bool bDestroyingHierarchy
)

   MixedRealityCaptureComponent.h  

virtual void OnRegister()

   MixedRealityCaptureComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   MixedRealityCaptureComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page