Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · member function

FOrreryTerrainBrushDabV2::

SampleMaskQ16

ExperimentalEditor only

The mask at a world point as the sculpt kernel reads it, in Q16 (0 to 65536).

Declaration

int32 SampleMaskQ16(const FVector2D& World_m) const;
Header
#include "Mode/OrreryTerrainEdExtensionV2.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Any thread; allocates nothing.

Description

Rotation, mirror, aspect ratio, the bilinear or bicubic sampler and the mip level are the kernel's: the call prepares the dab with the Tier 1 PrepareBrushMaskDab and reads SampleBrushMask, so the value equals the one the kernel uses for a post at that offset. The point is rounded to whole millimetres from Position_m.

Parameters

NameTypeDefaultMeaning
World_mconst FVector2D&—

The point, world metres (X and Y).

Returns

The value, or -1 when the point lies off the mask's rectangle, outside the disc of Radius_m (a round footprint), or when the dab has no mask. The falloff curve is the target's own.

Note.

Any thread; allocates nothing.