Orrery Terrain · OrreryTerrain module · class

UOrreryTerrainBrushAsset

A brush mask as an asset: a baked, content-hashed grid that scales a brush per post or shapes a height Stamp.

Declaration

UCLASS(BlueprintType)
class UOrreryTerrainBrushAsset : public UDataAsset

Header: #include "OrreryTerrainBrushAsset.h"
Module: PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability: Stable: changes within a major version only add.
Thread: Game thread.
Derives from: UDataAsset
Blueprint: “Orrery Terrain Brush Asset”, a Blueprint type

Description

The asset keeps the baked bytes (the mask's canonical bytes) and nothing else at runtime. The source texture or TIFF is editor-only data: a cooked game needs neither, and the hash covers the baked bytes, so two bakes of one image give one hash. In the editor, changing the source or a bake setting rebakes; RebakeMask does it by hand. A game registers the asset with a terrain (UOrreryTerrainSubsystem::RegisterBrush) and names it through GetMaskId in FOrreryTerrainBrushBP::Mask.

Note.

Experimental in v1.0. Game thread.

Functions

UOrreryTerrainBrushAsset
HasMaskBlueprint
Whether the asset holds a baked mask.
GetMaskIdBlueprint
The mask's id: its content hash, which a sculpt record carries.
GetMaskSideBlueprint
Samples a side of the baked mask; 0 when not baked.
GetMaskBitsBlueprint
Bits a sample of the baked mask; 0 when not baked.
BakeFromPixelsBlueprint
Bake raw single-channel pixels into this asset, replacing any baked mask (game code and tests; the editor bakes from SourceTexture or TiffFile).
BakeFromTextureBlueprint
Bake a texture into this asset with the asset's Usage, Side and Depth.
SetMask
Take a mask made elsewhere, such as FBrushMask::Decode of bytes a server sent.
GetMask
The decoded mask, or null when not baked.

Properties

Name	Type	Default	Meaning
`Usage`BlueprintReadOnly	`EOrreryTerrainBrushUsage`	`EOrreryTerrainBrushUsage::Strength`	What the mask is for; picks the default side and depth.
`Side`BlueprintReadOnly	`int32`	`0`	Samples a side of the baked mask, 0 for the usage default (256 Strength, 1024 Height). Rounded to the nearest power of two from 8 to 2048.
`Depth`BlueprintReadOnly	`EOrreryTerrainBrushDepth`	`EOrreryTerrainBrushDepth::Default`	Bits a sample; Default follows Usage (8 for Strength, 16 for Height).
`DefaultAngle`BlueprintReadWrite	`double`	`0.0`	The angle a tool starts with for this mask, degrees (`FOrreryTerrainBrushBP::MaskAngle`).
`DefaultRadius`BlueprintReadWrite	`double`	`2000.0`	The radius a tool starts with for this mask, cm; a Height mask is a Stamp, so this may be kilometres.
`DefaultAspect`BlueprintReadWrite	`double`	`1.0`	The mask's width over its height (`FOrreryTerrainBrushBP::MaskAspect`); 1 for a square mask.
`SuggestedHeight`BlueprintReadWrite	`double`	`0.0`	A height a Stamp tool starts with when this brush is picked, metres (the tool's Height; negative digs). 0 suggests none and leaves the tool's Height alone. Editor palette only: no sculpt record carries it, and a stamp placed from code names its own.
`bSuggestBlend`BlueprintReadWrite	`bool`	`false`	Whether picking this brush in the Stamp tool also sets its Blend to SuggestedBlend. Editor palette only.
`SuggestedBlend`BlueprintReadWrite	`EOrreryTerrainStampBlend`	`EOrreryTerrainStampBlend::Max`	The blend a Stamp tool starts with when this brush is picked and bSuggestBlend is set.

Blueprint

Bake from PixelsOrrery › Terrain › Brush
Bake from TextureOrrery › Terrain › Brush
Get Mask BitsOrrery › Terrain › Brush
Get Mask IdOrrery › Terrain › Brush
Get Mask SideOrrery › Terrain › Brush
Has MaskOrrery › Terrain › Brush