Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · function

Tool::

EvaluateFalloff

Brush strength factor at a normalised distance, 0 to 1.

Declaration

inline double EvaluateFalloff(EOrreryTerrainFalloff Falloff, double T, double Start = 0.0);
Header
#include "Tools/OrreryTerrainBrushFalloff.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Tier 3 helper, any thread.

Description

OrreryTerrain::Native::FalloffWeight, the curve the sculpt kernel evaluates in Q16 fixed point, for a Blueprint falloff. Tier 3 helper, any thread.

Parameters

NameTypeDefaultMeaning
FalloffEOrreryTerrainFalloff—

The curve.

Tdouble—

Distance from the brush centre over the radius; above 1 is outside the brush.

Startdouble0.0

Falloff start S in [0, 1): the inner radius fraction of full strength. t is remapped to max(0, (t-S)/(1-S)) before the curve (FOrreryTerrainBrushBP::FalloffStart).

Returns

Strength factor in [0, 1]; 0 outside the brush.