UAvaMask2DBaseModifier

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 UAvaMask2DBaseModifier
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMask/Public/Mask2D/AvaMask2DBaseModifier.h
Include Path #include "Mask2D/AvaMask2DBaseModifier.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UAvaMask2DBaseModifier :  
    public UActorModifierArrangeBaseModifier ,  
    public IGeometryMaskClient

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constants

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

FName GenerateUniqueMaskName()

 Utility to generate a unique mask name based on the associated Actor Mask2D/AvaMask2DBaseModifier.h  

float GetBlurStrength()

   Mask2D/AvaMask2DBaseModifier.h  

const FName GetChannel()

   Mask2D/AvaMask2DBaseModifier.h  

int32 GetInnerFeatherRadius()

   Mask2D/AvaMask2DBaseModifier.h  

int32 GetOuterFeatherRadius()

   Mask2D/AvaMask2DBaseModifier.h  

bool IsInverted()

   Mask2D/AvaMask2DBaseModifier.h  

void SetBlurStrength ( float InBlurStrength
)

   Mask2D/AvaMask2DBaseModifier.h  

void SetChannel ( FName InChannel
)

   Mask2D/AvaMask2DBaseModifier.h  

void SetInnerFeatherRadius ( int32 InFeatherRadius
)

   Mask2D/AvaMask2DBaseModifier.h  

void SetIsInverted ( const bool bInInvert
)

   Mask2D/AvaMask2DBaseModifier.h  

void SetOuterFeatherRadius ( int32 InFeatherRadius
)

   Mask2D/AvaMask2DBaseModifier.h  

void SetUseParentChannel ( const bool bInUseParentChannel
)

   Mask2D/AvaMask2DBaseModifier.h  

bool UseBlur ()

   Mask2D/AvaMask2DBaseModifier.h  

void UseBlur ( bool bInUseBlur
)

   Mask2D/AvaMask2DBaseModifier.h  

bool UseFeathering ()

   Mask2D/AvaMask2DBaseModifier.h  

void UseFeathering ( bool bInUseFeathering
)

   Mask2D/AvaMask2DBaseModifier.h  

bool UseParentChannel()

   Mask2D/AvaMask2DBaseModifier.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   Mask2D/AvaMask2DBaseModifier.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CanvasParamsToLocal ( bool bInResolveCanvas
)

 Stores specific properties on the canvas locally. Mask2D/AvaMask2DBaseModifier.h  
  Mask2D/AvaMask2DBaseModifier.h  

InComponentClass * FindOrAddMaskComponent ( AActor* InActor
)

   Mask2D/AvaMask2DBaseModifier.h  

UGeometryMaskCanvas * GetCurrentCanvas ( bool bInResolveCanvas
)

 Returns or resolves the currently referenced canvas. Mask2D/AvaMask2DBaseModifier.h  

UGeometryMaskWorldSubsystem * GetGeometryMaskWorldSubsystem ( const ULevel** OutLevel
) const

 Returns world subsystem and, optionally, the level for this modifier Mask2D/AvaMask2DBaseModifier.h  

UAvaMaskMaterialInstanceSubsystem * GetMaterialInstanceSubsystem()

   Mask2D/AvaMask2DBaseModifier.h  

UAvaObjectHandleSubsystem * GetObjectHandleSubsystem()

   Mask2D/AvaMask2DBaseModifier.h  

void LocalParamsToCanvas()

 Apply locally stored parameters to the canvas. Mask2D/AvaMask2DBaseModifier.h  

void OnBlurChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void OnCanvasChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void OnChannelChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void OnFeatherChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void OnInvertedChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void OnMaskSetCanvas ( const UGeometryMaskCanvas* InCanvas,
AActor* InActor
)

   Mask2D/AvaMask2DBaseModifier.h  

void OnUseParentChannelChanged()

   Mask2D/AvaMask2DBaseModifier.h  

void ResetCanvas()

 Called to reset the canvas. Calls OnCanvasReset Mask2D/AvaMask2DBaseModifier.h  

void RestoreActors()

 Restores modified actors to their original state and clears cache data Mask2D/AvaMask2DBaseModifier.h  

void SetupChannelName()

   Mask2D/AvaMask2DBaseModifier.h  

void TryResolveCanvas()

   Mask2D/AvaMask2DBaseModifier.h  

UTexture * TryResolveCanvasTexture ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

   Mask2D/AvaMask2DBaseModifier.h  

bool TryResolveParentChannel()

 Returns true if parent channel was found Mask2D/AvaMask2DBaseModifier.h  

void UpdateCanvas()

   Mask2D/AvaMask2DBaseModifier.h  

void VisualizeMask()

   Mask2D/AvaMask2DBaseModifier.h
  • CallInEditor
  • Category="Mask2D"

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void OnCanvasReset()

 Called when the canvas has reset Mask2D/AvaMask2DBaseModifier.h  

virtual void OnCanvasSet ( TNotNull< UGeometryMaskCanvas* > InCanvas
)

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

virtual void OnMaterialsChanged ( UObject* InMaterialOwner,
const TArray< TSharedPtr< IAvaMaskMaterialHandle > >& InMaterialHandles
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void RemoveFromActor ( AActor* InActor
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void RestoreActorPreState ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void SaveActorPreState ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void SetupMaskComponent ( UActorComponent* InComponent
)

   Mask2D/AvaMask2DBaseModifier.h  

Overridden from UActorModifierCoreBase

Name Remarks Include Path Unreal Specifiers

virtual void Apply()

   Mask2D/AvaMask2DBaseModifier.h  

virtual void OnModifiedActorTransformed()

   Mask2D/AvaMask2DBaseModifier.h  

virtual void OnModifierAdded ( EActorModifierCoreEnableReason InReason
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void OnModifierCDOSetup ( FActorModifierCoreMetadata& InMetadata
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void OnModifierRemoved ( EActorModifierCoreDisableReason InReason
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void RestorePreState()

   Mask2D/AvaMask2DBaseModifier.h  

Overridden from IActorModifierSceneTreeUpdateHandler

Name Remarks Include Path Unreal Specifiers

virtual void OnSceneTreeTrackedActorChildrenChanged ( int32 InIdx,
const TSet< TWeakObjectPtr< AActor > >& InPreviousChildrenActors,
const TSet< TWeakObjectPtr< AActor > >& InNewChildrenActors
)

   Mask2D/AvaMask2DBaseModifier.h  

virtual void OnSceneTreeTrackedActorParentChanged ( int32 InIdx,
const TArray< TWeakObjectPtr< AActor > >& InPreviousParentActor,
const TArray< TWeakObjectPtr< AActor > >& InNewParentActor
)

   Mask2D/AvaMask2DBaseModifier.h  

Overridden from IActorModifierRenderStateUpdateHandler

Name Remarks Include Path Unreal Specifiers

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

   Mask2D/AvaMask2DBaseModifier.h  

Overridden from IGeometryMaskClient

Name Remarks Include Path Unreal Specifiers

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

   Mask2D/AvaMask2DBaseModifier.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ActorSupportsMaskReadWrite ( const AActor* InActor
)

   Mask2D/AvaMask2DBaseModifier.h  

static UAvaMask2DBaseModifier * FindMaskModifierOnActor ( const AActor* InActor
)

 Utility to find an existing modifier on the provided actor or it's parent Mask2D/AvaMask2DBaseModifier.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ActorData_DEPRECATED TMap< TWeakObjectPtr< AActor >, FAvaMask2DActorData > Cached actor data to apply/restore Mask2D/AvaMask2DBaseModifier.h
  • NonPIEDuplicateTransient
  • Meta=(DeprecatedProperty)
MaterialCollectionHandleData_DEPRECATED TMap< TWeakObjectPtr< UObject >, FInstancedStruct >   Mask2D/AvaMask2DBaseModifier.h  
MaterialHandleData_DEPRECATED TMap< TWeakObjectPtr< UMaterialInterface >, FInstancedStruct >   Mask2D/AvaMask2DBaseModifier.h
  • DuplicateTransient

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page