1. Epic GamesDeveloper
  3. UAvaBooleanModifier

UAvaBooleanModifier

This modifier allows you to apply a mask on a certain shape, this will affect every shape it collides with that matches options

API > API/Plugins > API/Plugins/AvalancheModifiers > API/Plugins/AvalancheModifiers/Modifiers

Inheritance Hierarchy

References

   
Module AvalancheModifiers
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheModifiers/Public/Modifiers/AvaBooleanModifier.h
Include #include "Modifiers/AvaBooleanModifier.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UAvaBooleanModifier :  
    public UAvaGeometryBaseModifier ,  
    public IAvaTransformUpdateHandler

Remarks

This modifier allows you to apply a mask on a certain shape, this will affect every shape it collides with that matches options

Variables

  Type Name Description
Protected variable UProperty Category, Meta editinstanceonly, getter, setter uint8 Channel Channel to only apply this tool on shapes with the same channel
Protected variable UProperty Transient duplicatetransient, textexporttransient FAvaBooleanModifierSharedChannelInfo ChannelInfo General infos on the channel used by this modifier profiler
Protected variable UProperty duplicatetransient, nontransactional TSet< TWeakObjectPtr< UAvaBooleanModifier > > CollidingModifiers Colliding actor modifiers to quickly update
Protected variable UProperty Category, Meta editinstanceonly, getter, setter EAvaBooleanMode Mode Mode to use when shapes are colliding, none means you will be masked otherwise you are masking
Protected variable UProperty duplicatetransient, nontransactional TArray< TObjectPtr< UMaterialInterface > > OriginalMaterials Original materials before we apply the mask material
Protected variable UProperty Transient FAvaModifiersParametricMaterial ParametricMaskMaterial  

Functions

  Type Name Description
Protected function void  
Protected function Static void  
Protected function Const void Creates depth for a mask shape that has none
Public function Const UFunction BlueprintPure, Category uint8  
Public function Const const FAvaBooleanModifierSharedChannelInfo &  
Public function Const UFunction BlueprintPure, Category EAvaBooleanMode

GetMode ()

  
Protected function void  
Protected function void  
Protected function Const void

OnMaskVisibilityChange ( const UWorld* World,
bool bMaskActorVisible
)

 Called by the editor to change visibility of mask in a world
Protected function void  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void

SetChannel ( uint8 InChannel
)

  
Public function UFunction BlueprintCallable, Category void  
Protected function void  
Protected function void  
Protected function void  

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 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 when a modifier is disabled
Protected function Virtual void Called when a modifier is enabled
Protected function Virtual void Called after the modifier is removed from a stack and uninitialized after actor destruction
Protected 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 IAvaTransformUpdateHandler

  Type Name Description
Protected function Virtual void

OnTransformUpdated ( AActor* InActor,
bool bInParentMoved
)

 Callback when a tracked actor transform changes

Constants

Name Description
MinDepth This is the min depth threshold needed on the mask for it to work properly

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page