UAvaMask2DWriteModifier

Uses scene actors to create a mask texture and applies it to attached actors

API > API/Plugins > API/Plugins/AvalancheMask

Uses scene actors to create a mask texture and applies it to attached actors

   
Name UAvaMask2DWriteModifier
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMask/Public/Mask2D/AvaMask2DWriteModifier.h
Include Path #include "Mask2D/AvaMask2DWriteModifier.h"

Syntax

UCLASS (BlueprintType)  
class UAvaMask2DWriteModifier :  
    public UAvaMask2DBaseModifier ,  
    public IGeometryMaskWriteInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAvaMask2DWriteModifier()

   Mask2D/AvaMask2DWriteModifier.h  

Constants

Name Type Remarks Include Path
PropertyChangeDispatcher const TAvaPropertyChangeDispatcher< UAvaMask2DWriteModifier > Used for PECP Mask2D/AvaMask2DWriteModifier.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

EGeometryMaskCompositeOperation GetWriteOperation()

   Mask2D/AvaMask2DWriteModifier.h  

void SetWriteOperation ( const EGeometryMaskCompositeOperation InWriteOperation
)

   Mask2D/AvaMask2DWriteModifier.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ApplyWrite ( TNotNull< AActor* > InActor
)

   Mask2D/AvaMask2DWriteModifier.h  

bool ApplyWrite ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

   Mask2D/AvaMask2DWriteModifier.h  

void OnWriteOperationChanged()

   Mask2D/AvaMask2DWriteModifier.h  

void SetupMaskWriteComponent ( IGeometryMaskWriteInterface* InMaskWriter
)

   Mask2D/AvaMask2DWriteModifier.h  

Protected Virtual

Overridden from UAvaMask2DBaseModifier

Name Remarks Include Path Unreal Specifiers

virtual void OnCanvasReset()

 Called when the canvas has reset Mask2D/AvaMask2DWriteModifier.h  

virtual void OnCanvasSet ( TNotNull< UGeometryMaskCanvas* > InCanvas
)

 Called when the canvas has been set Mask2D/AvaMask2DWriteModifier.h  

virtual void RemoveFromActor ( AActor* InActor
)

   Mask2D/AvaMask2DWriteModifier.h  

virtual void SetupMaskComponent ( UActorComponent* InComponent
)

   Mask2D/AvaMask2DWriteModifier.h  

Overridden from UActorModifierCoreBase

Name Remarks Include Path Unreal Specifiers

virtual void Apply()

   Mask2D/AvaMask2DWriteModifier.h  

virtual void OnModifierCDOSetup ( FActorModifierCoreMetadata& InMetadata
)

   Mask2D/AvaMask2DWriteModifier.h  

virtual void OnModifierDisabled ( EActorModifierCoreDisableReason InReason
)

   Mask2D/AvaMask2DWriteModifier.h  

virtual void OnModifierEnabled ( EActorModifierCoreEnableReason InReason
)

   Mask2D/AvaMask2DWriteModifier.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   Mask2D/AvaMask2DWriteModifier.h  

Overridden from IActorModifierRenderStateUpdateHandler

Name Remarks Include Path Unreal Specifiers

virtual void OnRenderStateUpdated ( AActor* InActor,
UActorComponent* InComponent
)

   Mask2D/AvaMask2DWriteModifier.h  

Overridden from IGeometryMaskWriteInterface

Name Remarks Include Path Unreal Specifiers

virtual void DrawToCanvas ( FCanvas* InCanvas
)

   Mask2D/AvaMask2DWriteModifier.h  

virtual UE::GeometryMask::FMaskWriter * GetMaskWriter()

   Mask2D/AvaMask2DWriteModifier.h  

virtual const FGeometryMaskWriteParameters & GetParameters()

   Mask2D/AvaMask2DWriteModifier.h  

virtual bool IsMaskWriterEnabled()

   Mask2D/AvaMask2DWriteModifier.h  

virtual FOnGeometryMaskSetCanvasNativeDelegate & OnSetCanvas()

   Mask2D/AvaMask2DWriteModifier.h  

virtual void SetParameters ( FGeometryMaskWriteParameters& InParameters
)

   Mask2D/AvaMask2DWriteModifier.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page