beginTerrainStroke

beginTerrainStroke(grid, options): StrokeRun & object

Starts a height stroke on the grid with its points so far, and returns the run that adds each next one; see applyTerrainStroke. level is the height Flatten moves toward.

Parameters

Parameter	Type
grid	HeightGrid
options	{ clear: boolean; erase: boolean; families?: ScatterFamily[]; level?: number; lower: boolean; material?: string; multiplier?: number; points: [number, number][]; radius: number; shape: "circle" | "square"; strength: number; tool: "paint" | "smooth" | "scatter" | "sculpt" | "flatten"; }
options.clear	boolean
options.erase	boolean
options.families?	ScatterFamily[]
options.level?	number
options.lower	boolean
options.material?	string
options.multiplier?	number
options.points	[number, number][]
options.radius	number
options.shape	"circle" | "square"
options.strength	number
options.tool	"paint" | "smooth" | "scatter" | "sculpt" | "flatten"

Returns

StrokeRun & object