1. Epic GamesDeveloper
  3. UAvaMask2DBaseModifier

UAvaMask2DBaseModifier

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

API > API/Plugins > API/Plugins/AvalancheMask > API/Plugins/AvalancheMask/Mask2D

Inheritance Hierarchy

References

   
Module AvalancheMask
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheMask/Public/Mask2D/AvaMask2DBaseModifier.h
Include #include "Mask2D/AvaMask2DBaseModifier.h"

Syntax

UCLASS (Abstract)  
class UAvaMask2DBaseModifier : public UAvaArrangeBaseModifier

Remarks

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

Variables

  Type Name Description
Protected variable UProperty duplicatetransient TMap< TWeakObjectPtr< AActor >, FAvaMask2DActorData > ActorData Cached actor data to apply/restore
Protected variable UProperty Transient FName AutoChannelName Cached auto channel name, used when the user adds the modifier and immediately sets the mode to Source, in which case a different channel name is chosen.
Protected variable UProperty Category, Meta BlueprintReadWrite editinstanceonly, getter, setter bool bInverted Whether to apply the mask as inverted (visible becomes invisible and vice versa)
Protected variable bool bIsRestoring  
Protected variable UProperty Category, Meta BlueprintReadWrite getter, setter float BlurStrength  
Protected variable UProperty Category, Meta BlueprintReadWrite getter, setter bool bUseBlur  
Protected variable UProperty Category, Meta BlueprintReadWrite getter, setter bool bUseFeathering  
Protected variable UProperty Category, Meta BlueprintReadWrite editinstanceonly, getter, setter bool bUseParentChannel Whether to get the channel from the parent (first one that specifies a mask channel)
Protected variable TWeakObjectPtr< UTexture > CanvasTextureWeak Reference to the underlying canvas texture
Protected variable UProperty Category, EditAnywhere, Meta Transient duplicatetransient, noclear TWeakObjectPtr< UGeometryMaskCanvas > CanvasWeak Reference to the Canvas used
Protected variable UProperty Category, Meta BlueprintReadWrite editinstanceonly, getter, setter FName Channel Channel to read to or write from
Protected variable UProperty Category, Meta BlueprintReadWrite getter, setter int32 InnerFeatherRadius  
Protected variable UProperty Transient duplicatetransient FName LastResolvedCanvasName Reference to the last resolved canvas name, as stored in CanvasWeak
Protected variable UProperty duplicatetransient TMap< TWeakObjectPtr< UObject >, FInstancedStruct > MaterialCollectionHandleData  
Protected variable TMap< TObjectKey< UObject >, TSharedPtr< IAvaMaskMaterialCollectionHandle > > MaterialCollectionHandles  
Protected variable UProperty duplicatetransient TMap< TWeakObjectPtr< UMaterialInterface >, FInstancedStruct > MaterialHandleData  
Protected variable UProperty Transient TWeakObjectPtr< UAvaMaskMaterialInstanceSubsystem > MaterialInstanceSubsystem  
Protected variable UProperty Transient TWeakObjectPtr< UAvaObjectHandleSubsystem > ObjectHandleSubsystem  
Protected variable UProperty Category, Meta BlueprintReadWrite getter, setter int32 OuterFeatherRadius  
Protected variable UProperty Category, Meta visibleanywhere FName ParentChannel Channel found when GetChannelFromParent is true

Functions

  Type Name Description
Protected function Static bool

ActorSupportsMaskReadWrite ( const AActor* InActor
)

  
Protected function void Stores specific properties on the canvas locally.
Public function Static UAvaMask2DBaseModifier *

FindMaskModifierOnActor ( const AActor* InActor
)

 Utility to find an existing modifier on the provided actor or it's parent
Protected function UActorComponent *

FindOrAddMaskComponent ( TSubclassOf< UActorComponent > InComponentClass,
AActor* InActor
)

  
Protected function InComponentClass *  
Public function Const FName Utility to generate a unique mask name based on the associated Actor
Public function Const float  
Public function Const const FName  
Protected function UGeometryMaskCanvas * Returns or resolves the currently referenced canvas.
Public function Const int32  
Protected function UAvaMaskMaterialInstanceSubsystem *  
Protected function UAvaObjectHandleSubsystem *  
Public function Const int32  
Public function Const bool  
Protected function void Apply locally stored parameters to the canvas.
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

OnMaskSetCanvas ( const UGeometryMaskCanvas* InCanvas,
AActor* InActor
)

  
Protected function Virtual void

OnMaterialsChanged ( UPrimitiveComponent* InPrimitiveComponent,
const TArray< TSharedPtr< IAvaMaskMaterialHandle > >& InMaterialHandles
)

  
Protected function void  
Protected function Virtual void

RemoveFromActor ( AActor* InActor
)

  
Protected function Virtual void

RestoreActorPreState ( AActor* InActor,
const FAvaMask2DActorData& InActorData
)

  
Protected function Virtual void

SaveActorPreState ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

  
Public function void

SetBlurStrength ( float InBlurStrength
)

  
Public function void

SetChannel ( FName InChannel
)

  
Public function void

SetInnerFeatherRadius ( int32 InFeatherRadius
)

  
Public function void

SetIsInverted ( const bool bInInvert
)

  
Public function void

SetOuterFeatherRadius ( int32 InFeatherRadius
)

  
Protected function void  
Protected function Virtual void  
Public function void

SetUseParentChannel ( const bool bInUseParentChannel
)

  
Protected function void  
Protected function UTexture *  
Protected function bool Returns true if parent channel was found
Public function Const bool

UseBlur ()

  
Public function void

UseBlur ( bool bInUseBlur
)

  
Public function Const bool  
Public function void

UseFeathering ( bool bInUseFeathering
)

  
Public function Const bool  

Overridden from UActorModifierCoreBase

  Type Name Description
Protected function Virtual void

Apply ()

 Override in child classes, apply this modifier on the actual actor, call Next or Fail to complete the modifier execution
Protected function Virtual void Called when modified actor transform is updated if this modifier is enabled
Protected function Virtual void Called after the modifier was added to a stack and initialized after creation or serialization or duplication
Protected function Virtual void Override metadata for this modifier, called only once before modifier CDO is registered
Protected function Virtual void Called after the modifier is removed from a stack and uninitialized after actor destruction
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

  
Protected function Virtual void Override in child classes, unapply this modified changes and restore the state before this modifier is applied
Protected function Virtual void Override in child classes, called before applying this modifier

Overridden from IAvaSceneTreeUpdateHandler

  Type Name Description
Protected function Virtual void

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

  
Protected function Virtual void

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

  

Constants

Name Description
PropertyChangeDispatcher Used for PECP

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page