Skip to content

Class

ObjectPlacementGeometry3D

Generated GDScript class reference for GridPlacement.ObjectPlacementGeometry3D.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

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.
column_keyMethod
resolve_surface_heightMethod
resolve_surface_item_nameMethod
placement_positionMethod
footprint_cellsMethod
nearest_edgeMethod
face_normal_from_rayMethod
edge_positionMethod
edge_yawMethod
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.
declared_face_socketMethod
face_mount_transformMethod
anchorProperty
anchor_localProperty
derived_face_mount_transformMethod
anchorProperty
outward_localProperty
yaw_fromProperty
targetProperty
yaw_toProperty
yawProperty
rotated_socket_localProperty
rotated_socket_worldProperty
anchor_localProperty
edge_keyMethod
face_keyMethod
face_occupancy_keyMethod
is_cardinal_face_normalMethod
mount_height_bandMethod