Skip to content

Class

SurfaceSupportSampler3D

Generated GDScript class reference for GridPlacement.SurfaceSupportSampler3D.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Physics-backed 3D support sampler. Casts deterministic downward rays across a GRID footprint. The returned evidence is consumed by [SurfaceSupportEvaluator3D]; this class owns no placement policy.

Source: addons/grid_placement/systems/building/3d/surface_support_sampler_3d.gd

Syntax

class SurfaceSupportSampler3D extends RefCounted

Members

NameKindSummary
SAMPLES_PER_CELLFieldFour quadrant samples per footprint cell.
RAY_ORIGIN_ABOVEFieldStart far enough above ordinary terrain relief to avoid originating below it.
RAY_LENGTHFieldMaximum supported vertical search distance.
ROLE_GRIDField
ROLE_CENTERField
supportedPropertyOne downward support ray: where it landed (or the intended X/Z on a miss), the surface normal (zero on a miss), and its role: a footprint coverage sample or the explicit footprint-center probe.
positionProperty
normalProperty
roleProperty
surface_nameProperty
sample_footprintMethod
samplesProperty
space_stateProperty
highest_reference_yProperty
center_sumProperty
cell_centerProperty
grid_surfaceProperty
origin_yProperty
stepProperty
start_offsetProperty
grid_basisProperty
cell_centerProperty
local_offsetProperty
world_offsetProperty
sample_xzProperty
footprint_centerProperty
originProperty
targetProperty
queryProperty
hitProperty
colliderProperty