Navigation
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)
class UAvaMask2DBaseModifier : public UActorModifierArrangeBaseModifier
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorModifierCoreBase → UActorModifierAttachmentBaseModifier → UActorModifierArrangeBaseModifier → UAvaMask2DBaseModifier
Implements Interfaces
- IActorModifierRenderStateUpdateHandler
- IActorModifierSceneTreeUpdateHandler
- IActorModifierTransformUpdateHandler
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 |
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() |
Stores specific properties on the canvas locally. | Mask2D/AvaMask2DBaseModifier.h | |
UActorComponent * FindOrAddMaskComponent
(
TSubclassOf< UActorComponent > InComponentClass, |
Mask2D/AvaMask2DBaseModifier.h | ||
InComponentClass * FindOrAddMaskComponent
(
AActor* InActor |
Mask2D/AvaMask2DBaseModifier.h | ||
UGeometryMaskCanvas * GetCurrentCanvas() |
Returns or resolves the currently referenced canvas. | 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, |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void OnMaterialsChanged
(
UObject* InMaterialOwner, |
Mask2D/AvaMask2DBaseModifier.h | ||
void OnUseParentChannelChanged() |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void RemoveFromActor
(
AActor* InActor |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void RestoreActorPreState
(
AActor* InActor, |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void SaveActorPreState
(
AActor* InActor, |
Mask2D/AvaMask2DBaseModifier.h | ||
void SetupChannelName() |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void SetupMaskComponent
(
UActorComponent* InComponent |
Mask2D/AvaMask2DBaseModifier.h | ||
void TryResolveCanvas() |
Mask2D/AvaMask2DBaseModifier.h | ||
UTexture * TryResolveCanvasTexture
(
AActor* InActor, |
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 |
|
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 | ||
virtual void SavePreState() |
Mask2D/AvaMask2DBaseModifier.h |
Overridden from IActorModifierSceneTreeUpdateHandler
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnSceneTreeTrackedActorChildrenChanged
(
int32 InIdx, |
Mask2D/AvaMask2DBaseModifier.h | ||
virtual void OnSceneTreeTrackedActorParentChanged
(
int32 InIdx, |
Mask2D/AvaMask2DBaseModifier.h |
Overridden from IActorModifierRenderStateUpdateHandler
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnRenderStateUpdated
(
AActor* InActor, |
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 |