mirror of
https://github.com/duckietm/Nitro-V3.git
synced 2026-06-20 07:26:19 +00:00
feat(floorplan-editor): React rewrite + live in-room preview + UX polish
Complete modernization of the floor-plan editor. Three layered
changes shipped together since they share state shapes and the
test infrastructure stubs.
1) React rewrite (state + hooks + views + tests)
Drops the FloorplanEditorContext singleton + legacy view
components and replaces them with a pure-React reducer
architecture:
- state/ — typed FloorplanState + FloorplanAction union,
pure reducer covering PAINT_TILE / ERASE_TILE /
ADJUST_HEIGHT / SET_DOOR / SET_DOOR_DIR / SET_THICKNESS /
SET_WALL_HEIGHT / BRUSH_SET / SELECT_RECT / SELECT_ALL /
CLEAR_SELECTION / SQUARE_SELECT_TOGGLE / IMPORT_STRING /
APPLY_REMOTE_DIFF / APPLY_REMOTE_SNAPSHOT. Source-tagged
('local' | 'remote') so the editor can distinguish user
edits from server pushes. Co-located encoding helpers
(parseTilemap / serializeTilemap) and area-counter
selectors.
- hooks/ — useFloorplanReducer (wraps useReducer with a
history stack + loadFromServer + undo/redo), useTool
(pointer events -> dispatch), usePointerToTile (screen
-> tile projection that respects the viewBox origin so
pan/zoom stays accurate).
- views/ — FloorplanCanvasSVG, FloorplanHeightPicker,
FloorplanToolbar, FloorplanOptionsPanel,
FloorplanImportExport, FloorplanTile,
FloorplanPreviewSVG (alternative iso preview kept as a
fallback view, not wired into the main layout).
- Co-located Vitest suites for every module above (encoding,
reducer, selectors, hooks, views, integration). 100+ new
test cases.
2) Live in-room preview (NEW capability)
useFloorplanLiveSync drives client-side preview of the edit
directly into the active room — every tile / door / wall
height / thickness change is applied through
GetRoomMessageHandler().applyFloorModelLocally (new public
method on the renderer, see paired renderer PR) with
zero server traffic during editing. The wire
UpdateFloorPropertiesMessageComposer is only sent when the
user explicitly clicks Save. Thickness slider additionally
calls RoomEngine.updateRoomInstancePlaneThickness for
zero-latency wall/floor-depth feedback while dragging.
Toggle 'Live preview ON / OFF' in the bottom strip (default
ON) lets the user opt out if they want to keep changes
contained to the editor's own preview until Save.
Revert button re-applies the original snapshot locally so
the room snaps back to where it was when the editor opened.
3) UX polish
- Undo / Redo (Ctrl+Z, Ctrl+Shift+Z / Ctrl+Y) backed by a
100-step history stack inside useFloorplanReducer. Local
mutating actions push history; brush/selection UI bumps
and remote dispatches bypass it; loadFromServer wipes the
stack.
- Zoom 40-600 % with Ctrl+wheel, +/- buttons, % label.
Shift+drag or middle-mouse drag pans the canvas.
- Auto-fit on first paint: computes the screen-space
bounding box of the painted (non-blocked) tiles, picks the
zoom that just contains them with a 5 % margin, pans so
the room sits in the viewport centre. Default view is now
'room fills the canvas' instead of 'room is a dot at the
top-centre of a huge empty canvas'. Clicking the % label
re-runs the fit; crosshair button keeps zoom and recentres
the pan only.
- Door direction control: arrows + door icon triplet
(8-way rotate by single click on prev/next, full cycle
forward on the icon itself). Wall and floor thickness
collapse from two 4-button rows into two compact
segmented selectors (active state in emerald). Saves
significant horizontal space.
- Habbo floor pattern tile (~186 B PNG, vendored from
habbofurni.com/images/furni_floor.png) tiled as the
canvas background with image-rendering: pixelated so the
texture stays crisp at every zoom level. Replaces the
solid black background.
Test infrastructure
nitro-renderer.mock grows constructors / proxies / functions
for everything the new floor-editor tests transitively
import (floor composers + events, RoomEngineEvent,
ILinkEventTracker, convertNumbersForSaving /
convertSettingToNumber, GetRoomMessageHandler,
GetTicker, GetRenderer, NitroTicker, RoomPreviewer with a
sufficiently real .updatePreviewModel / dispose surface,
and a TextureUtils.createRenderTexture that returns an
object with a no-op .destroy). test-setup adds a no-op
ResizeObserver polyfill (jsdom doesn't ship one and the
optional FloorplanRoomPreview observes its container) and
a draggable-windows-container portal root for tests that
mount NitroCardView.
Files: 44 changed (mostly new). yarn typecheck 0 errors,
yarn test 341/341 green.
This commit is contained in:
+123
-1
@@ -233,6 +233,94 @@ export class UserProfileComposer extends StubClass {}
|
||||
// `ChooserSelectionFilter` is used as a string enum in some call sites.
|
||||
export const ChooserSelectionFilter = makeEnumProxy('ChooserSelectionFilter');
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Floor plan constants
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export const FloorAction = makeEnumProxy('FloorAction');
|
||||
|
||||
export const TILE_SIZE = 32;
|
||||
|
||||
export const HEIGHT_SCHEME = 'x0123456789abcdefghijklmnopq';
|
||||
|
||||
export const MAX_NUM_TILE_PER_AXIS = 64;
|
||||
|
||||
export const COLORMAP: object = {
|
||||
'x': '101010',
|
||||
'0': '0065ff', '1': '0091ff', '2': '00bcff', '3': '00e8ff',
|
||||
'4': '00ffea', '5': '00ffbf', '6': '00ff93', '7': '00ff68',
|
||||
'8': '00ff3d', '9': '19ff00',
|
||||
'a': '44ff00', 'b': '70ff00', 'c': '9bff00', 'd': 'f2ff00',
|
||||
'e': 'ffe000', 'f': 'ffb500', 'g': 'ff8900', 'h': 'ff5e00',
|
||||
'i': 'ff3200', 'j': 'ff0700', 'k': 'ff0023', 'l': 'ff007a',
|
||||
'm': 'ff00a5', 'n': 'ff00d1', 'o': 'ff00fc',
|
||||
'p': 'd600ff', 'q': 'aa00ff'
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Floor plan editor — composer stubs and event classes
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
// Composer stubs for floor-plan-editor message events
|
||||
export class GetRoomEntryTileMessageComposer extends StubClass {}
|
||||
export class GetOccupiedTilesMessageComposer extends StubClass {}
|
||||
export class UpdateFloorPropertiesMessageComposer extends StubClass
|
||||
{
|
||||
public tilemap: string;
|
||||
public doorX: number;
|
||||
public doorY: number;
|
||||
public dir: number;
|
||||
public thicknessWall: number;
|
||||
public thicknessFloor: number;
|
||||
public wallHeight: number;
|
||||
constructor(tilemap: string, doorX: number, doorY: number, dir: number, thicknessWall: number, thicknessFloor: number, wallHeight: number)
|
||||
{
|
||||
super();
|
||||
this.tilemap = tilemap;
|
||||
this.doorX = doorX;
|
||||
this.doorY = doorY;
|
||||
this.dir = dir;
|
||||
this.thicknessWall = thicknessWall;
|
||||
this.thicknessFloor = thicknessFloor;
|
||||
this.wallHeight = wallHeight;
|
||||
}
|
||||
}
|
||||
|
||||
// Event class stubs for useMessageEvent registration
|
||||
export class FloorHeightMapEvent extends StubClass {}
|
||||
export class RoomVisualizationSettingsEvent extends StubClass {}
|
||||
export class RoomEntryTileMessageEvent extends StubClass {}
|
||||
export class RoomOccupiedTilesMessageEvent extends StubClass {}
|
||||
export const RoomEngineEvent = makeEnumProxy('RoomEngineEvent');
|
||||
|
||||
// Link tracker stubs
|
||||
export type ILinkEventTracker = { linkReceived: (url: string) => void; eventUrlPrefix: string };
|
||||
export const AddLinkEventTracker = vi.fn();
|
||||
export const RemoveLinkEventTracker = vi.fn();
|
||||
|
||||
// Thickness conversion helpers — mirror the renderer's real mapping
|
||||
export const convertNumbersForSaving = (v: number): number =>
|
||||
{
|
||||
switch(v)
|
||||
{
|
||||
case 0: return -2;
|
||||
case 1: return -1;
|
||||
case 3: return 1;
|
||||
default: return 0;
|
||||
}
|
||||
};
|
||||
|
||||
export const convertSettingToNumber = (v: number): number =>
|
||||
{
|
||||
switch(v)
|
||||
{
|
||||
case 0.25: return 0;
|
||||
case 0.5: return 1;
|
||||
case 2: return 3;
|
||||
default: return 2;
|
||||
}
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Singleton getters
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -267,10 +355,44 @@ export const GetCommunication = vi.fn(stubManager);
|
||||
export const GetConfiguration = vi.fn(stubManager);
|
||||
export const GetLocalizationManager = vi.fn(stubManager);
|
||||
export const GetRoomEngine = vi.fn(stubManager);
|
||||
export const GetRoomMessageHandler = vi.fn(stubManager);
|
||||
export const GetRoomSessionManager = vi.fn(stubManager);
|
||||
|
||||
// RoomPreviewer — only the bits the editor's FloorplanRoomPreview
|
||||
// component touches. PREVIEW_COUNTER is a static field that the
|
||||
// real renderer increments to allocate unique preview-room IDs;
|
||||
// keeping it as a mutable static lets the editor mount/unmount
|
||||
// repeatedly across tests without colliding.
|
||||
export class RoomPreviewer
|
||||
{
|
||||
static PREVIEW_COUNTER = 0;
|
||||
|
||||
constructor(public readonly _engine: unknown, public readonly _id: number) {}
|
||||
|
||||
public updatePreviewModel(_model: string, _wallHeight: number, _scale?: boolean): void {}
|
||||
public modifyRoomCanvas(_w: number, _h: number): void {}
|
||||
public getRoomCanvas(_w: number, _h: number): unknown { return null; }
|
||||
public getRenderingCanvas(): unknown { return null; }
|
||||
public updatePreviewRoomView(): void {}
|
||||
public changeRoomObjectDirection(): void {}
|
||||
public changeRoomObjectState(): void {}
|
||||
public dispose(): void {}
|
||||
}
|
||||
export const GetSessionDataManager = vi.fn(stubManager);
|
||||
export const GetTickerTime = vi.fn(() => 0);
|
||||
export const TextureUtils = stubManager();
|
||||
export const GetTicker = vi.fn(stubManager);
|
||||
export const GetRenderer = vi.fn(stubManager);
|
||||
export class NitroTicker {}
|
||||
// TextureUtils — a real-enough stub of the createRenderTexture
|
||||
// roundtrip. Tests that mount LayoutRoomPreviewerView allocate a
|
||||
// texture on mount and destroy it on unmount; without a real
|
||||
// `.destroy` method the unmount cleanup throws.
|
||||
export const TextureUtils = {
|
||||
createRenderTexture: (_w: number, _h: number) => ({
|
||||
destroy: (_options?: unknown) => undefined
|
||||
}),
|
||||
generateImage: () => null
|
||||
};
|
||||
export const NitroVersion = stubManager();
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user