Navigation
API > API/Plugins > API/Plugins/MetaHumanImageViewerEditor
A component that handles displaying of footage data in an AB viewport. Internally this component holds two plane static meshes with a material capable of displaying color or depth data. The meshes are transformed to account for the camera position and to be in the right aspect ratio.
| Name | UMetaHumanFootageComponent |
| Type | class |
| Header File | /Engine/Plugins/MetaHuman/MetaHumanAnimator/Source/MetaHumanImageViewerEditor/Public/MetaHumanFootageComponent.h |
| Include Path | #include "MetaHumanFootageComponent.h" |
Syntax
UCLASS (MinimalAPI)
class UMetaHumanFootageComponent : public UPrimitiveComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMetaHumanFootageComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMetaHumanFootageComponent() |
MetaHumanFootageComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Camera | FString | MetaHumanFootageComponent.h |
|
|
| CameraCalibration | TObjectPtr< UCameraCalibration > | MetaHumanFootageComponent.h |
|
|
| DepthDataFar | int32 | MetaHumanFootageComponent.h | ||
| DepthDataNear | int32 | Depth range. | MetaHumanFootageComponent.h | |
| EffectiveCalibration | FCameraCalibration | An effective calibration to use when no actual calibration is known. | MetaHumanFootageComponent.h | |
| FootagePlanes | TMap< EABImageViewMode, FFootagePlaneData > | MetaHumanFootageComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UStaticMeshComponent * GetFootagePlaneComponent
(
EABImageViewMode InViewMode |
Returns the plane component of the given AB view mode | MetaHumanFootageComponent.h | |
TArray< class UStaticMeshComponent * > GetFootagePlaneComponents() |
Returns both plane components | MetaHumanFootageComponent.h | |
void GetFootageScreenRect
(
const FVector2D& InViewportSize, |
Calculates the field of view required to focus on this footage component also returns the screen rectangle this component occupies on screen a transform corresponding the extrinsic camera parameters that can be used to focus the viewport on the footage in 3D space | MetaHumanFootageComponent.h | |
void SetCamera
(
const FString& InCamera |
Sets the active camera to use in the calibration | MetaHumanFootageComponent.h | |
void SetCameraCalibration
(
UCameraCalibration* InCameraCalibration |
Position the plane meshes to be in the right location and scale based given a camera calibration | MetaHumanFootageComponent.h | |
void SetDepthRange
(
int32 InDepthNear, |
Sets the depth range used in the footage plane material | MetaHumanFootageComponent.h | |
void SetFootageResolution
(
const FVector2D& InResolution |
When no calibration is known, specify the footage resolution instead in order to position the plane | MetaHumanFootageComponent.h | |
void SetFootageVisible
(
EABImageViewMode InViewMode, |
Set the footage plane visibility on the given AB view mode | MetaHumanFootageComponent.h | |
void SetMediaTextures
(
UTexture* InColorMediaTexture, |
Set the media textures that represent color and depth data. | MetaHumanFootageComponent.h | |
void SetUndistortionEnabled
(
EABImageViewMode InViewMode, |
Set if we should display undistort the footage being displayed | MetaHumanFootageComponent.h | |
void ShowColorChannel
(
EABImageViewMode InViewMode |
Display the color channel in the given AB view mode | MetaHumanFootageComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
MetaHumanFootageComponent.h |