UGeometryMaskCanvasReferenceComponentBase

API > API/Plugins > API/Plugins/GeometryMask

   
Name UGeometryMaskCanvasReferenceComponentBase
Type class
Header File /Engine/Plugins/VirtualProduction/GeometryMask/Source/GeometryMask/Public/GeometryMaskTypes.h
Include Path #include "GeometryMaskTypes.h"

Syntax

UCLASS (Abstract)  
class UGeometryMaskCanvasReferenceComponentBase :  
    public UActorComponent ,  
    public IGeometryMaskClient

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UGeometryMaskCanvasReferenceComponentBase()

   GeometryMaskTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UTextureRenderTarget2DArray * GetRenderTarget()

 Returns the render target 2D array that the canvas draws to GeometryMaskTypes.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Rendering"

UCanvasRenderTarget2D * GetTexture()

   GeometryMaskTypes.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Rendering"
  • Meta=(DeprecatedFunction, DeprecationMessage="GetTexture (CanvasRenderTarget2D) has been deprecated. Use GetRenderTarget (TextureRenderTarget2DArray) and pass it into Mask_Textures parameter instead")

void ReceiveSetCanvas ( const UGeometryMaskCanvas* InCanvas
)

 Implement to perform an operation with the provided canvas. GeometryMaskTypes.h
  • BlueprintImplementableEvent
  • CallInEditor
  • Category="Canvas"
  • Meta=(DisplayName="Canvas Changed")

Public Virtual

Protected

Name Remarks Include Path Unreal Specifiers

bool TryResolveNamedCanvas ( FName InCanvasName
)

   GeometryMaskTypes.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool Cleanup()

   GeometryMaskTypes.h  

virtual bool TryResolveCanvas()

 Override to inject CanvasName into TryResolveCanvas(FName). GeometryMaskTypes.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   GeometryMaskTypes.h  

virtual void OnRegister()

   GeometryMaskTypes.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   GeometryMaskTypes.h  

Overridden from IGeometryMaskClient

Name Remarks Include Path Unreal Specifiers

virtual bool ForEachUsedCanvasName ( TFunctionRef< bool(FName)> InFunc
) const

 Iterates each canvas that the client uses GeometryMaskTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page