Navigation
API > API/Plugins > API/Plugins/MediaViewer
Image resource for the AB Image Viewer representing a source that can be displayed as a 2d image.
| Name | FMediaImageViewer |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MediaViewer/Source/MediaViewer/Public/ImageViewer/MediaImageViewer.h |
| Include Path | #include "ImageViewer/MediaImageViewer.h" |
Syntax
class FMediaImageViewer :
public FNotifyHook ,
public TSharedFromThis< FMediaImageViewer >
Inheritance Hierarchy
- FNotifyHook → FMediaImageViewer
- FSharedFromThisBase → TSharedFromThis → FMediaImageViewer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMediaImageViewer
(
const FMediaImageViewerInfo& InImageInfo |
ImageViewer/MediaImageViewer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FMediaImageViewer() |
ImageViewer/MediaImageViewer.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BackgroundColorBrush | const FSlateColorBrush | ImageViewer/MediaImageViewer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FMediaViewerLibraryItem > CreateLibraryItem() |
ImageViewer/MediaImageViewer.h | ||
virtual void ExtendStatusBar
(
FMediaImageStatusBarExtender& InOutStatusBarExtender |
Extend the status bar (top over overlay). | ImageViewer/MediaImageViewer.h | |
virtual void ExtendToolbar
(
const TSharedRef< FExtender >& InOutToolbarExtender |
Extend the tool bar (top). | ImageViewer/MediaImageViewer.h | |
virtual TSharedPtr< FStructOnScope > GetCustomSettingsOnScope() |
Returns a custom struct on scope to display media-specific settings to the user. | ImageViewer/MediaImageViewer.h | |
const FMediaImageViewerInfo & GetInfo() |
ImageViewer/MediaImageViewer.h | ||
virtual TSharedPtr< SWidget > GetOverlayWidget
(
EMediaImageViewerPosition InPosition, |
Returns a widget to place on the overlay. | ImageViewer/MediaImageViewer.h | |
FVector2D GetPaintOffset
(
const FVector2D& InViewerSize, |
Applies paint settings to the default center position. | ImageViewer/MediaImageViewer.h | |
FVector2D GetPaintOffsetForViewerCenter
(
const FVector2D& InViewerSize |
Returns the location of the top-left corner of the image for it to be painted in the centre of the viewer. | ImageViewer/MediaImageViewer.h | |
| ImageViewer/MediaImageViewer.h | |||
const FMediaImagePaintSettings & GetPaintSettings () |
ImageViewer/MediaImageViewer.h | ||
FVector2D GetPaintSize() |
Returns the size of the image, including things like scale. | ImageViewer/MediaImageViewer.h | |
| ImageViewer/MediaImageViewer.h | |||
const FMediaImageViewerPanelSettings & GetPanelSettings () |
ImageViewer/MediaImageViewer.h | ||
TOptional< TVariant< FColor, FLinearColor > > GetPixelColor
(
const FIntPoint& InPixelCoords, |
ImageViewer/MediaImageViewer.h | ||
FVector2D GetViewerCenter
(
const FVector2D& InViewerSize |
Returns the center of the viewer, not necessarily the center of the splitter it's contained within. | ImageViewer/MediaImageViewer.h | |
virtual bool IsValid() |
ImageViewer/MediaImageViewer.h | ||
virtual bool OnKeyPressed
(
const FInputKeyEventArgs& InEventArgs |
Responds to key input in this image's viewport. | ImageViewer/MediaImageViewer.h | |
virtual void OnMouseMove
(
const FVector2D& InMousePosition |
Responds to mouse movement in this viewer's viewport. | ImageViewer/MediaImageViewer.h | |
virtual bool OnTrackingStarted
(
const FInputEventState& InInputState, |
Responds to tracking started in this viewer's viewport. | ImageViewer/MediaImageViewer.h | |
virtual void OnTrackingStopped
(
const FIntPoint& InMousePosition |
Responds to tracking stopped in this viewer's viewport. | ImageViewer/MediaImageViewer.h | |
void Paint
(
FMediaImagePaintParams& InPaintParams |
Paint the panel and image on to the viewer. | ImageViewer/MediaImageViewer.h | |
| Called, for instance, when an image is dropped into the viewer and it creates an image viewer, but the image already exists in the library. | ImageViewer/MediaImageViewer.h |
Overridden from FNotifyHook
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void NotifyPostChange
(
const FPropertyChangedEvent& InPropertyChangedEvent, |
ImageViewer/MediaImageViewer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateClippingZone CreateSlateClippingZone
(
const FSlateRect& InCullingRect, |
ImageViewer/MediaImageViewer.h | ||
virtual void PaintImage
(
FMediaImagePaintParams& InPaintParams, |
ImageViewer/MediaImageViewer.h | ||
virtual void PaintPanel
(
FMediaImagePaintParams& InPaintParams, |
ImageViewer/MediaImageViewer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FText GetObjectDisplayName
(
const UObject* InObject |
Given an object, tries to fetch a nice display name for it. | ImageViewer/MediaImageViewer.h |