Skip to content

Class

ObjectPlacementGeometry3D

Generated GDScript class reference for GridPlacement.ObjectPlacementGeometry3D.

Status
Current
Version
v6.0
Source updated
2026-09-04
Generated on
2026-09-06

Pure 3D placement geometry and key helpers, extracted from [ObjectPlacementService3D] so the edge/face math and the registry-key algebra live in one focused, stateless utility. Every method is static — the service passes in whatever context a helper needs (the GridMap, a pre-resolved surface height, the cell size) so the helpers never hold placement state.

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

Syntax

class ObjectPlacementGeometry3D extends RefCounted

Members

NameKindSummary
NO_GROUNDFieldSentinel matching [constant GridMap.INVALID_CELL_ITEM] column keys.
seam_shift_3dMethod
shiftProperty
yawProperty
basisProperty
sizeProperty
used_axesProperty
dirProperty
grid_axisProperty
mesh_dirProperty
face_distProperty
cells_alongProperty
cell_lenProperty
stepProperty
column_keyMethod
resolve_surface_heightMethod
resolve_surface_item_nameMethod
placement_positionMethod
footprint_cellsMethod
cell_world_aabbMethod
single_cell_world_aabbMethod
nearest_edgeMethod
face_normal_from_rayMethod
edge_positionMethod
edge_yawMethod
is_cell_cornerMethod
CARDINAL_CORNERSFieldThe four XZ cell-corner offsets, in stable order.
nearest_cornerMethod
corner_positionMethod
corner_yawMethod
corner_keyMethod
face_positionMethod
face_yawMethod
FACE_SOCKET_NODE_NAMEFieldNode name of the optional declared FACE mount socket on a provider scene root. Authored as a Node3D child whose origin sits on the wall's visible face plane with -Z pointing outward. When present, the service mates FACE consumers to this real surface instead of the cell-derived plane fallback.
FACE_SOCKET_SYMMETRIC_METAFieldProvider meta key stamped by the service when the provider's snap profile explicitly opts into rotational symmetry ([member PlacementSnapProfile3D. face_socket_symmetric]). Presence with a true value permits yaw derivation of the canonical socket onto faces with no authored socket; absent meta is fail-closed (cell-derived fallback instead).
declared_face_socketMethod
face_mount_transformMethod
anchorProperty
anchor_localProperty
derived_face_mount_transformMethod
anchorProperty
targetProperty
yaw_toProperty
socketsProperty
outwardProperty
candidate_dirProperty
yaw_candidateProperty
direct_worldProperty
anchor_localProperty
symmetricProperty
outward_localProperty
yaw_fromProperty
yawProperty
rotated_socket_localProperty
rotated_socket_worldProperty
anchor_localProperty
edge_keyMethod
face_keyMethod
face_occupancy_keyMethod
CARDINAL_FACE_NORMALSFieldThe four vertical cardinal face normals, in stable order. Shared by the face-key algebra and the service's face registration sweeps.
is_cardinal_face_normalMethod
yaw_steps_from_rotationMethod
mount_height_bandMethod
cell_derived_face_transformMethod