Navigation
API > API/Plugins > API/Plugins/GeometryMask
Wraps a GeometryMaskCanvas, and discovers/registers writers.
| Name | AGeometryMaskCanvasActor |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/GeometryMask/Source/GeometryMask/Public/GeometryMaskCanvasActor.h |
| Include Path | #include "GeometryMaskCanvasActor.h" |
Syntax
UCLASS (BlueprintType)
class AGeometryMaskCanvasActor :
public AActor ,
public IGeometryMaskClient
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AGeometryMaskCanvasActor
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AGeometryMaskCanvasActor
(
const FObjectInitializer& ObjectInitializer |
GeometryMaskCanvasActor.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CanvasName | FName | Identifies the referenced Canvas. | GeometryMaskCanvasActor.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTextureRenderTarget2DArray * GetRenderTarget() |
Returns the render target 2D array that the canvas draws to | GeometryMaskCanvasActor.h |
|
UCanvasRenderTarget2D * GetTexture() |
GeometryMaskCanvasActor.h |
|
Public Virtual
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginPlay() |
GeometryMaskCanvasActor.h | ||
virtual void RerunConstructionScripts() |
GeometryMaskCanvasActor.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
GeometryMaskCanvasActor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void FindWriters() |
Find writers on child actors and add them to the referenced canvas. | GeometryMaskCanvasActor.h | |
bool TryResolveCanvas() |
Resolve/locate the canvas identified by CanvasName. | GeometryMaskCanvasActor.h |
Protected Virtual
Overridden from IGeometryMaskClient
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ForEachUsedCanvasName
(
TFunctionRef< bool(FName)> InFunc |
Iterates each canvas that the client uses | GeometryMaskCanvasActor.h |