UPlaneFalloff::SetPlaneFalloff

Plane scalar field that will be defined only within a distance from a plane

Choose your operating system:

Windows

macOS

Linux

References

Module

FieldSystemEngine

Header

/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Public/Field/FieldSystemObjects.h

Include

#include "Field/FieldSystemObjects.h"

Source

/Engine/Source/Runtime/Experimental/FieldSystem/Source/FieldSystemEngine/Private/Field/FieldSystemObjects.cpp

Syntax

UPlaneFalloff * SetPlaneFalloff
(
    float Magnitude,
    float MinRange,
    float MaxRange,
    float Default,
    float Distance,
    FVector Position,
    FVector Normal,
    EFieldFalloffType Falloff
)

Remarks

Plane scalar field that will be defined only within a distance from a plane

Parameters

Parameter

Description

Magnitude

Magnitude of the plane falloff field

MinRange

The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

MaxRange

The initial function value between 0 and 1 will be scaled between MinRange and MaxRange before being multiplied by magnitude

Default

The field value will be set to default if the sample projected distance ((Sample Position - Center Position).dot(Plane Normal)) is higher than the Plane Distance

Distance

Distance limit for the plane falloff field starting from the center position and extending in the direction of the plane normal

Position

Plane center position of the plane falloff field

Normal

Plane normal of the plane falloff field

Falloff

Type of falloff function used to model the evolution of the field from the plane surface to the distance isosurface