Orrery Terrain · OrreryTerrain module · member function
UOrreryTerrainSubsystem::
ApplySplat
BlueprintApply one splat dab: one masked Paint step for each used channel of the splat, in the order red, green, blue, alpha, inside the open stroke, so the whole stroke is one undo however many dabs it holds.
Declaration
UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Sculpt")
EOrreryTerrainSculptResult ApplySplat(int64 Stroke, const FOrreryTerrainBrushBP& Dab, const FOrreryTerrainSplat& Splat);The graph as text
- Apply Splat (function call; Target is Orrery Terrain Subsystem)
- In Target (self object): self
- In Stroke (Integer64): 0
- In Dab (OrreryTerrainBrushBP): not connected
- In Splat (OrreryTerrainSplat): not connected
- Out Return Value (EOrreryTerrainSculptResult): not connected
- Header
#include "OrreryTerrainSubsystem.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrain");in your module’s Build.cs.- Stability
- Stable: changes within a major version only add.
- Thread
- Every member function is game thread unless it says otherwise. (the rule of UOrreryTerrainSubsystem)
- Blueprint
- Apply Splat, in Orrery › Terrain › Sculpt
Description
The steps take Dab's centre, radius, falloff, PaintOpacity and the mask's angle, mirror, square and aspect (Kind, PaintLayer and Mask are the splat's). Each step is an ordinary Paint record, so a replica and a replay repeat them in order. A Paint step moves its layer toward full and scales the others down by the same fraction, so a later channel takes from the earlier ones; the splat asset's bake compensates (UOrreryTerrainSplatAsset), so full opacity reaches the image's weights. Use a Constant falloff and bSquare to lay the image over the rectangle without a vignette.
The masks must all be registered before the first step (RegisterSplat), else nothing is applied and the answer is Refused. A step the limits refuse (a paint layer over MaxPaintLayer) stops the dab there, the earlier channels stay painted.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Stroke | int64 | — | The open stroke, as BeginStroke returned it. |
Dab | const FOrrery | — | Where and how large; its Kind, PaintLayer and Mask are ignored. |
Splat | const FOrrery | — | A registered splat (RegisterSplat). |
Returns
Applied (a step changed a post), NoChange (none did, or the splat is empty), or the first step's other answer (Pending over ground still loading, Refused, OutOfOrder, NoTerrain, ReadOnly).