kinogaki-document

What it is

Depends on

For its tests alone

Third-party

Used by

Modules

• clipboardCopy and paste of nodes and objects, after Houdini (P56).421 lines
• document (private)Document: the open document.418 lines
• document::edits (private)The document's edits that hosts and packages ask for by name: each one Document::transact step (or part of the open gesture's).16 lines
• document::edits::clipboard (private)Copy, Cut, Paste and Duplicate where the user is: the picked items of the open network level, or the selected objects at an object level.116 lines
• document::edits::images (private)The scene's Image nodes' files as steps: a file embedded, embedded bytes written out (Scene::embed, Scene::extract).32 lines
• document::edits::import (private)Import where the user is: at an object level, a file's items as objects, the top-level ones selected, and a picture as an Image node in the root Images library; inside a network, a displayed File node reading the file, or an Image node reading a picture, or ...144 lines
• document::edits::keys (private)Keys of the open network's nodes' parameters and of objects' rows: setting and removing a key, and clearing a row's channel; and the edit rule on objects' rows: an animated row's edit is its key at the current time.259 lines
• document::edits::nodes (private)Edits of the network the location shows: adding, renaming, moving and deleting nodes, Freeze and Unfreeze, and Set Output.293 lines
• document::edits::objects (private)Scene-level edits: objects, their tree, names, flags and placements.268 lines
• document::edits::subnets (private)Subnets and assets in the open network: Collapse and Extract, the interface a subnet promotes, and Save as Asset, Make Unique, Make Main, Unpack, Update from Library and new instances.321 lines
• document::history (private)Undo: snapshots of the document, steps between them, and gestures.323 lines
• document::location (private)Where the user is in the scene, as one value: an object level, or a level of the network an object holds, or of the network a node of it holds (Description::inside, Houdini's matnet).238 lines
• document::picks (private)What is picked on the open network level: one NodePicks for whichever level is open, the same for every context (picks are the location's; no context filters them).110 lines
• document::placements (private)Placements: where the scene's objects are at the current time, and what their bodies hold, as a stamp; Placer: their world placements, placed again only where an edit moved them.156 lines
• document::slots (private)Session slots: state a package keeps per editing session, outside the project file (a component selection, a set of picks).117 lines
• document::transaction (private)Document::transact, the one way the scene changes, and the Transaction an edit is given.192 lines
• kindsObject kinds as the document reads them: core's Part, the kinds the installed packages declare (ObjectKindSpec), and the placeholder kind of an object no installed package reads.149 lines
• object (private)Object: one scene object.339 lines
• object::animated (private)An object's channels: keys on its placement's rows, translate, rotate, scale and pivot, each a vector of three.99 lines
• object::body (private)What an object is beyond what every object has: core's Part, a package's body, or a placeholder kept as read.90 lines
• object::flags (private)The outliner's flag columns, per object: Lock, Visible, Template and Render (owner, 2026-10-16).109 lines
• object::kind_rows (private)An object's kind rows: the values its kind holds in its body, keyed as <facet>.<name> beside its placement's rows.501 lines
• object::sheet (private)An object's kind rows as its sheet shows them (Scene::kind_sheet): its Display Quality where its value is meshed for display, a render setup's own fields, then the rows of its kind's facet (Object::row, listed as kind_rows says).397 lines
• object::transform (private)An object's local transform: scale, then rotation about X, Y and Z (degrees, each axis fixed in the parent's frame, Houdini's default SRT/XYZ order), then translation.108 lines
• pathsScene paths: the one way a parameter names another node or object (Houdini's operator paths).76 lines
• paths::copies (private)Copies name the copies: a relative path from a copied node to something copied with it names that thing's copy (Houdini's rule).77 lines
• paths::fits (private)Whether a place is something a Reference row may name, in the SDK's terms (Fits): by object kind, by the data type of the result, or by the context of the network it holds or sits in.166 lines
• paths::follow (private)Paths follow what they name: after an edit that renames or moves things, every exact path is rewritten to name what it named before, absolute as absolute and relative as relative (Houdini's rule), an object row's op: path among them.206 lines
• paths::opop: rows: where no wire reaches, a row of an object's kind that reads an image (a dome's) names an Image node by op: and its absolute path (OP, Houdini's spelling).202 lines
• paths::text (private)A path as text: absolute or relative, patterns, and the stored form.84 lines
• paths::walk (private)Walking the scene's tree of names: what each place holds, the place above it, and resolving and writing paths over them.322 lines
• sceneScene: the objects, their tree under one root, and the project's settings.367 lines
• scene::adding (private)Adding objects: Scene::add, and Adding, many added in one go (an Import's).142 lines
• scene::assetsA scene's assets: the exact definitions its instances use, embedded in the project, one per name (Houdini's digital assets; the network side is kinogaki_network::Definition).395 lines
• scene::check (private)What every edit of a scene passes when it is committed, and what a locked object refuses.156 lines
• scene::files (private)The files on disk the scene's nodes name (Scene::files_named): what a host watches for changes, so a file written by another application is read again.35 lines
• scene::imagesThe scene's Image nodes as a whole: every one, wherever it is (Scene::images), a file embedded in them (Scene::embed) and embedded bytes written out for them (Scene::extract).161 lines
• scene::importA file's items as objects (Import): a group becomes a Part, a value an object of the kind that adopts it (ObjectKindSpec::adopts), each placed, shown and named as the file says.304 lines
• scene::names (private)Object names beside their siblings: a path names one object, so no two objects under one parent share a name.52 lines
• scene::tree (private)The scene's tree edits but adding (adding): remove, move, group, ungroup, duplicate and graft.259 lines
• settingsProject settings: what a unit is, which axis is up, the ground grid, how many decimals lengths show, and the installed packages' stored values of the project.141 lines
• timeThe scene's time: the frame range (start, end and frames a second) is the document's and undone with it; the current time is navigation, as the view is.100 lines

Public types and traits

At the crate root

Structs DocumentFlagsGridSettingsKindSheetNodePicksObjectPlacePlaceholderPlacementsPlacerProjectSettingsSceneSnapshotTransactionTransform

Enums BodyFlagGridModeLocationOpenedSwatch

Type aliases Worlds

Re-exported from other crates

From kinogaki_network NodeIdObjectId

Besides these, 14 public functions at module level.