Sidewalk Spline Manager
Manages sidewalk spline data structures, including creation, removal, splitting, joining, undo/redo, profile copy/paste, and serialization. Works with `kit`, `populate`, and `geom` submodules.
Manages sidewalk spline data structures, including creation, removal, splitting, joining, undo/redo, profile copy/paste, and serialization. Works with kit, populate, and geom submodules.
Public Functions
| Function | Description |
|---|---|
M.getToolPrefixStr() | Returns the tool prefix string 'Sidewalk Spline' |
M.getEditModeKey() | Returns the edit mode key 'sidewalkSplineEditMode' |
M.getSidewalkSplines() | Returns the array of all sidewalk splines |
M.getSplineMap() | Returns the spline id-to-index map |
M.setSidewalkSpline(spline, idx) | Sets a spline at the given index with scene tree folder |
M.setSidewalkSplines(splines) | Replaces the entire spline collection |
M.getDefaultSliderParams() | Returns default UI slider parameters |
M.addNewSidewalkSpline() | Creates a new empty sidewalk spline with scene tree folder |
M.removeSidewalkSpline(idx) | Removes a spline at the given index and cleans up scene tree |
M.removeAllSidewalkSplines(isIncludeDisabled) | Removes all (or just enabled) splines |
M.deepCopySidewalkSpline(spline) | Deep copies a single spline (clears secondary geometry) |
M.deepCopySidewalkSplineState() | Deep copies the full collection of splines |
M.splitSidewalkSpline(splineIdx, nodeIdx) | Splits a spline at a node into two splines A and B |
M.joinSidewalkSplines(splineIdx1, nodeIdx1, splineIdx2, nodeIdx2) | Joins two unlooped splines into one |
M.singleSplineEditUndo(data) | Undo callback for single-spline edits |
M.singleSplineEditRedo(data) | Redo callback for single-spline edits |
M.transSplineEditUndo(data) | Undo callback for trans-spline edits (full replace) |
M.transSplineEditRedo(data) | Redo callback for trans-spline edits (full replace) |
M.objectSelectUndo(data) | Undo callback for object select operations |
M.objectSelectRedo(data) | Redo callback for object select operations |
M.copySidewalkSplineProfile(spline) | Copies spline profile settings to clipboard |
M.pasteSidewalkSplineProfile(spline) | Pastes clipboard profile settings onto a spline |
M.hasCopiedProfile() | Returns true if a profile is copied |
M.copyProfileTemplate(spline) | Copies profile template data for serialization |
M.pasteProfileTemplate(spline, templateData) | Pastes profile template data onto a spline |
M.serializeSidewalkSpline(spline) | Serializes a sidewalk spline using string.buffer |
M.deserializeSidewalkSpline(data, isFromFile) | Deserializes a spline, reloads kit, creates folder |
M.updateDirtySidewalkSplines() | Updates geometry and meshes of any dirty splines |
Example: Creating, Populating, and Managing Splines
local splineMgr = require('editor/sidewalkSpline/splineMgr')
-- Create a new sidewalk spline
splineMgr.addNewSidewalkSpline()
local splines = splineMgr.getSidewalkSplines()
local spline = splines[#splines]
-- Add nodes to the spline (external code sets spline.nodes, widths, nmls)
spline.nodes = { vec3(0, 0, 0), vec3(10, 0, 0), vec3(20, 5, 0) }
spline.widths = { 2.0, 2.0, 2.0 }
spline.nmls = { vec3(0, 0, 1), vec3(0, 0, 1), vec3(0, 0, 1) }
spline.isDirty = true
-- Update all dirty splines (recomputes geometry and populates meshes)
splineMgr.updateDirtySidewalkSplines()
-- Deep copy a spline for undo state
local backup = splineMgr.deepCopySidewalkSpline(spline)
-- Split a spline at node 2 into two halves
splineMgr.splitSidewalkSpline(1, 2)
-- Copy and paste profile between splines
splineMgr.copySidewalkSplineProfile(splines[1])
if splineMgr.hasCopiedProfile() then
splineMgr.pasteSidewalkSplineProfile(splines[2])
end
-- Serialize for save/load
local data = splineMgr.serializeSidewalkSpline(spline)
local restored = splineMgr.deserializeSidewalkSpline(data, true)
-- Remove a spline
splineMgr.removeSidewalkSpline(1)
-- Remove all splines (including disabled)
splineMgr.removeAllSidewalkSplines(true)
-- Get default slider parameters for UI
local params = splineMgr.getDefaultSliderParams()
-- params.verticalOffset, params.jitterAmount, params.alignmentWeight, params.splineRandomSeedSpline Data Structure
Each spline contains:
name,id,isLoop,isEnabled,isDirtynodes,widths,nmls- primary geometrydivPoints,divWidths,tangents,binormals,normals- secondary (computed) geometryverticalOffset,jitterAmount,alignmentWeight,splineRandomSeedkitFolderPath,meshKit,kitDescription,pieceEnabledStatessceneTreeFolderId- SimGroup folder in scene tree
Functions
singleSplineEditUndo(sidewalkSplineData)
Handles single spline edit undo.
sidewalkSplineData(any)
singleSplineEditRedo(sidewalkSplineData)
Handles single spline edit redo.
sidewalkSplineData(any)
transSplineEditUndo(data)
Handles trans spline edit undo.
data(table)
transSplineEditRedo(data)
Handles trans spline edit redo.
data(table)
objectSelectUndo(data)
Handles object select undo.
data(table)
objectSelectRedo(data)
Handles object select redo.
data(table)
Returns: self
Functions
singleSplineEditUndo(sidewalkSplineData)
Handles single spline edit undo.
sidewalkSplineData(any)
singleSplineEditRedo(sidewalkSplineData)
Handles single spline edit redo.
sidewalkSplineData(any)
transSplineEditUndo(data)
Handles trans spline edit undo.
data(table)
transSplineEditRedo(data)
Handles trans spline edit redo.
data(table)
objectSelectUndo(data)
Handles object select undo.
data(table)
objectSelectRedo(data)
Handles object select redo.
data(table)
Returns: self
See Also
- Sidewalk Spline Kit - Related reference
- Sidewalk Spline Populate - Related reference
- World Editor Guide - Guide
Sidewalk Spline Populate
Handles the procedural placement of sidewalk meshes along splines - places rectangular pieces along the path with parallel-transport framing, fills gaps with triangular "pizza" pieces at turns, and ma
Sites Editor - Locations
Sub-editor for managing location elements within the Sites Editor. Handles hit-testing, gizmo-based transform editing (translate/scale), and undo/redo for location creation/removal.