Navigation
API > API/Plugins > API/Plugins/GeometryMaskEditor
Displays a named GeometryMaskCanvas.
| Name | SGeometryMaskCanvasPreview |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/GeometryMask/Source/GeometryMaskEditor/Public/Widgets/SGeometryMaskCanvasPreview.h |
| Include Path | #include "Widgets/SGeometryMaskCanvasPreview.h" |
Syntax
class SGeometryMaskCanvasPreview :
public SCompoundWidget ,
public FGCObject
Inheritance Hierarchy
- FGCObject → SGeometryMaskCanvasPreview
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SGeometryMaskCanvasPreview
- FSlateControlledConstruction → SWidget → SCompoundWidget → SGeometryMaskCanvasPreview
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SGeometryMaskCanvasPreview() |
Widgets/SGeometryMaskCanvasPreview.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SGeometryMaskCanvasPreview() |
Widgets/SGeometryMaskCanvasPreview.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AspectRatio | TAttribute< FOptionalSize > | Stores the aspect ratio of the referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
| bShowPaddingFrame | TAttribute< bool > | Widgets/SGeometryMaskCanvasPreview.h | ||
| CanvasId | TAttribute< FGeometryMaskCanvasId > | Id of the currently referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
| CanvasWeak | TWeakObjectPtr< UGeometryMaskCanvas > | Widgets/SGeometryMaskCanvasPreview.h | ||
| ColorChannel | TAttribute< EGeometryMaskColorChannel > | Color channel to display for the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
| DefaultTexture | TObjectPtr< UTexture > | Widgets/SGeometryMaskCanvasPreview.h | ||
| DefaultTexturePath | FSoftObjectPath | Widgets/SGeometryMaskCanvasPreview.h | ||
| HasSolidBackground | TAttribute< bool > | Widgets/SGeometryMaskCanvasPreview.h | ||
| Invert | TAttribute< bool > | Whether to invert the display of the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
| OpacityMultiplier | TAttribute< float > | Multiplies the overall opacity. | Widgets/SGeometryMaskCanvasPreview.h | |
| PreviewBrush | TSharedPtr< FSlateBrush > | Widgets/SGeometryMaskCanvasPreview.h | ||
| PreviewMaterialPath | FSoftObjectPath | Widgets/SGeometryMaskCanvasPreview.h | ||
| PreviewMID | TObjectPtr< UMaterialInstanceDynamic > | Widgets/SGeometryMaskCanvasPreview.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs this widget with InArgs | Widgets/SGeometryMaskCanvasPreview.h | |
FOptionalSize GetAspectRatio() |
Get the aspect ratio of the referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
UGeometryMaskCanvas * GetCanvas() |
Get the currently referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
const FGeometryMaskCanvasId & GetCanvasId() |
Get the id of the currently referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
const FName GetCanvasName() |
Get the name of the currently referenced canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
const EGeometryMaskColorChannel GetColorChannel
(
const bool bOnlyValid |
Get the color channel to display for the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
const float GetOpacity() |
Get the overall opacity multiplier value. | Widgets/SGeometryMaskCanvasPreview.h | |
const bool GetSolidBackground() |
Get whether a solid background is used or not (vs. compositing with alpha on widgets below). | Widgets/SGeometryMaskCanvasPreview.h | |
const bool IsInverted() |
Get whether to invert the display of the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
const bool IsPaddingFrameVisible() |
Widgets/SGeometryMaskCanvasPreview.h | ||
void SetCanvasId
(
const FGeometryMaskCanvasId& InCanvasId |
Sets the id of the currently referenced canvas, and resolves the canvas itself. | Widgets/SGeometryMaskCanvasPreview.h | |
void SetColorChannel
(
const EGeometryMaskColorChannel InColorChannel |
Set the color channel to display for the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
void SetInvert
(
const bool bInInverted |
Set whether to invert the display of the canvas. | Widgets/SGeometryMaskCanvasPreview.h | |
void SetOpacity
(
const float InValue |
Set the overall opacity multiplier value. | Widgets/SGeometryMaskCanvasPreview.h | |
void SetPaddingFrameVisiblity
(
const bool bInIsVisible |
Widgets/SGeometryMaskCanvasPreview.h | ||
void SetSolidBackground
(
const bool bInHasSolidBackground |
Set whether a solid background is used or not (vs. compositing with alpha on widgets below). | Widgets/SGeometryMaskCanvasPreview.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Tick
(
const FGeometry& InAllottedGeometry, |
Widgets/SGeometryMaskCanvasPreview.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& InCollector |
Widgets/SGeometryMaskCanvasPreview.h | ||
virtual FString GetReferencerName() |
Widgets/SGeometryMaskCanvasPreview.h |