Navigation
API > API/Plugins > API/Plugins/AvalancheModifiers
This modifier allows you to apply a mask on a certain shape, this will affect every shape it collides with that matches options
| Name | UAvaBooleanModifier |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheModifiers/Public/Modifiers/AvaBooleanModifier.h |
| Include Path | #include "Modifiers/AvaBooleanModifier.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UAvaBooleanModifier :
public UAvaGeometryBaseModifier ,
public IActorModifierTransformUpdateHandler
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorModifierCoreBase → UAvaGeometryBaseModifier → UAvaBooleanModifier
Implements Interfaces
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| MinDepth | float | This is the min depth threshold needed on the mask for it to work properly | Modifiers/AvaBooleanModifier.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LastTransform | FTransform | Track last transform during update to check against when moved | Modifiers/AvaBooleanModifier.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint8 GetChannel() |
Modifiers/AvaBooleanModifier.h |
|
|
const FAvaBooleanModifierSharedChannelInfo & GetChannelInfo() |
Modifiers/AvaBooleanModifier.h | ||
EAvaBooleanMode GetMode() |
Modifiers/AvaBooleanModifier.h |
|
|
void SetChannel
(
uint8 InChannel |
Modifiers/AvaBooleanModifier.h |
|
|
void SetMode
(
EAvaBooleanMode InMode |
Modifiers/AvaBooleanModifier.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyInternal() |
Modifiers/AvaBooleanModifier.h | ||
void CreateMaskDepth() |
Creates depth for a mask shape that has none | Modifiers/AvaBooleanModifier.h | |
void OnChannelChanged() |
Modifiers/AvaBooleanModifier.h | ||
void OnMaskingOptionsChanged() |
Modifiers/AvaBooleanModifier.h | ||
void OnMaskVisibilityChange
(
const UWorld* World, |
Called by the editor to change visibility of mask in a world | Modifiers/AvaBooleanModifier.h | |
void OnModeChanged() |
Modifiers/AvaBooleanModifier.h | ||
void RestoreOriginalMaterials() |
Modifiers/AvaBooleanModifier.h | ||
void SaveOriginalMaterials() |
Modifiers/AvaBooleanModifier.h | ||
void UpdateMaskDelegates() |
Modifiers/AvaBooleanModifier.h | ||
void UpdateMaskingMaterials() |
Modifiers/AvaBooleanModifier.h | ||
void UpdateMaskVisibility() |
Modifiers/AvaBooleanModifier.h |
Overridden from UActorModifierCoreBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Apply() |
Modifiers/AvaBooleanModifier.h | ||
virtual void OnModifierAdded
(
EActorModifierCoreEnableReason InReason |
Modifiers/AvaBooleanModifier.h | ||
virtual void OnModifierCDOSetup
(
FActorModifierCoreMetadata& InMetadata |
Modifiers/AvaBooleanModifier.h | ||
virtual void OnModifierDisabled
(
EActorModifierCoreDisableReason InReason |
Modifiers/AvaBooleanModifier.h | ||
virtual void OnModifierEnabled
(
EActorModifierCoreEnableReason InReason |
Modifiers/AvaBooleanModifier.h | ||
virtual void OnModifierRemoved
(
EActorModifierCoreDisableReason InReason |
Modifiers/AvaBooleanModifier.h | ||
virtual void RestorePreState() |
Modifiers/AvaBooleanModifier.h | ||
virtual void SavePreState() |
Modifiers/AvaBooleanModifier.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
Modifiers/AvaBooleanModifier.h |
Overridden from IActorModifierTransformUpdateHandler
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnTransformUpdated
(
AActor* InActor, |
Modifiers/AvaBooleanModifier.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ApplyTool
(
EAvaBooleanMode InMode, |
Modifiers/AvaBooleanModifier.h |