UAvaMask2DReadModifier

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

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UAvaMask2DReadModifier : public UAvaMask2DBaseModifier

Inheritance Hierarchy

Implements Interfaces

Constants

Name Type Remarks Include Path
MaxCanvasCount int32 Limit canvas count to 4 because a single linear color parameter is used to transmit the indices over. Mask2D/AvaMask2DReadModifier.h
PropertyChangeDispatcher const TAvaPropertyChangeDispatcher< UAvaMask2DReadModifier > Used for PECP Mask2D/AvaMask2DReadModifier.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetBaseOpacity()

   Mask2D/AvaMask2DReadModifier.h  

void SetBaseOpacity ( float InBaseOpacity
)

   Mask2D/AvaMask2DReadModifier.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   Mask2D/AvaMask2DReadModifier.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ApplyMaskState ( const UE::Ava::FMaterialBridgeWriteSlotContext& InContext,
UE::Ava::FMaterialBridgeWriteSlot& InSlot,
const FAvaMask2DMaskState& InMaskState
)

   Mask2D/AvaMask2DReadModifier.h  

bool ApplyRead ( TNotNull< UObject* > InMaterialContainer,
TConstArrayView< TNotNull< const UGeometryMaskCanvas* > > InCanvases
)

   Mask2D/AvaMask2DReadModifier.h  

bool ApplyRead ( AActor* InActor,
FAvaMask2DActorData& InActorData
)

   Mask2D/AvaMask2DReadModifier.h  

bool ApplyRead ( AActor* InActor,
FAvaMask2DActorData& InActorData,
FText& OutFailReason
)

   Mask2D/AvaMask2DReadModifier.h  

EBlendMode GetBlendMode()

 Get target blend mode dependent on modifier settings. Mask2D/AvaMask2DReadModifier.h  

void OnAdditionalChannelsChanged()

   Mask2D/AvaMask2DReadModifier.h  

void OnBaseOpacityChanged()

   Mask2D/AvaMask2DReadModifier.h  

void SetupMaskReadComponent ( IGeometryMaskReadInterface* InMaskReader
)

   Mask2D/AvaMask2DReadModifier.h  

void StoreActorState ( AActor* InActor
)

 Stores the container and material states for a given actor Mask2D/AvaMask2DReadModifier.h  

Protected Virtual

Overridden from UAvaMask2DBaseModifier

Name Remarks Include Path Unreal Specifiers

virtual void RemoveFromActor ( AActor* InActor
)

   Mask2D/AvaMask2DReadModifier.h  

virtual void SetupMaskComponent ( UActorComponent* InComponent
)

   Mask2D/AvaMask2DReadModifier.h  

Overridden from UActorModifierCoreBase

Name Remarks Include Path Unreal Specifiers

virtual void Apply()

   Mask2D/AvaMask2DReadModifier.h  

virtual void OnModifierCDOSetup ( FActorModifierCoreMetadata& InMetadata
)

   Mask2D/AvaMask2DReadModifier.h  

virtual void OnModifierDisabled ( EActorModifierCoreDisableReason InReason
)

   Mask2D/AvaMask2DReadModifier.h  

virtual void OnModifierEnabled ( EActorModifierCoreEnableReason InReason
)

   Mask2D/AvaMask2DReadModifier.h  

virtual void RestorePreState()

   Mask2D/AvaMask2DReadModifier.h  

virtual void SavePreState()

   Mask2D/AvaMask2DReadModifier.h  

Overridden from IActorModifierRenderStateUpdateHandler

Name Remarks Include Path Unreal Specifiers

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

   Mask2D/AvaMask2DReadModifier.h  

Overridden from IGeometryMaskClient

Name Remarks Include Path Unreal Specifiers

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

   Mask2D/AvaMask2DReadModifier.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page