vibe-sketcherDocumentation

vibesketcher.server.reticular

REST routes for reticular assembly from drawn blocks on explicit nets (#202).

Building goes through POST /api/documents/{id}/periodic/build with a kind: reticular recipe (revision-checked, recorded as an edit and undone like any build). These routes list the nets and preview an assembly without changing the document.

Functions

router(store)

Classes

ReticularPreviewRequest(*, recipe[, structure])

A preview reads the current document; the answer names its revision.

class vibesketcher.server.reticular.ReticularPreviewRequest(*, recipe, structure=False)[source]

Bases: BaseModel

A preview reads the current document; the answer names its revision.

Parameters:
model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

recipe: dict[str, Any]
structure: bool

Include the built structure in the answer (it can be large).

vibesketcher.server.reticular.router(store)[source]
Parameters:

store (Store)

Return type:

APIRouter