Core runtime

Session ownership, handles, diagnostics, frames, backend routing, and preview buffers.

This catalog contains 23 public symbols. Select a symbol for its exact signature, parameters, return contract, errors, members, aliases, and behavior notes.

Classes

Symbol	Import	Summary
Backend	from cadflow.backend import Backend	Base class for protocol classes.
CompatibilityBackend	from cadflow import CompatibilityBackend	Complete OCC implementation used for operations not migrated yet.
CoordinateFrame	from cadflow import CoordinateFrame	CoordinateFrame(origin: 'tuple[float, float, float]' = (0.0, 0.0, 0.0), x_axis: 'tuple[float, float, float]' = (1.0, 0.0, 0.0), y_axis: 'tuple[float, float, float]' = (0.0, 1.0, 0.0), z_axis: 'tuple[float, float, float]' = (0.0, 0.0, 1.0))
Diagnostic	from cadflow import Diagnostic	Diagnostic(severity: 'str', code: 'str', message: 'str', hint: 'str | None' = None, data: 'Mapping[str, Any]' = <factory>)
Model	from cadflow import Model	Explicit-session frontend analogous to a small CAD model context.
NativeBackend	from cadflow import NativeBackend	Dispatches handle-based operations to one explicit native session.
NativeSession	from cadflow import NativeSession	Owns native shapes and exposes batched primitive operations.
OperationReport	from cadflow import OperationReport	OperationReport(operation: 'str', status: 'str', output: 'Mapping[str, Any]' = <factory>, diagnostics: 'tuple[Diagnostic, ...]' = (), parameters: 'Mapping[str, Any]' = <factory>)
OperationResult	from cadflow import OperationResult	OperationResult(shape: 'Any | None', report: 'OperationReport')
PreviewMeshBuffer	from cadflow import PreviewMeshBuffer	Validated zero-copy views over one native preview mesh buffer.
Router	from cadflow import Router	Select a configured public backend implementation from the operation arguments.
Shape	from cadflow import Shape	Shape(_session: 'NativeSession', _handle: 'ShapeHandle')
ShapeHandle	from cadflow import ShapeHandle	An opaque, session-owned native shape reference.
Workplane	from cadflow import Workplane	Context manager and factory for local sketches.

Exceptions

Symbol	Import	Summary
NativeError	from cadflow import NativeError	Raised when the C++ backend rejects an operation.

Functions

Symbol	Import	Summary
capabilities	from cadflow import capabilities	Public function in this domain.
current_frame	from cadflow import current_frame	Public function in this domain.
legacy_api	from cadflow import legacy_api	Return the complete pre-refactor API for compatibility operations.
native_model	from cadflow import native_model	Public function in this domain.
parse_preview_mesh_buffer	from cadflow import parse_preview_mesh_buffer	Public function in this domain.
preview_mesh_buffer_to_glb	from cadflow import preview_mesh_buffer_to_glb	Wrap a native mesh buffer in the closed CadFlow triangle GLB profile.
use_frame	from cadflow import use_frame	Public function in this domain.

Constants

Symbol	Import	Summary
WORLD_FRAME	from cadflow.frame import WORLD_FRAME	CoordinateFrame(origin: 'tuple[float, float, float]' = (0.0, 0.0, 0.0), x_axis: 'tuple[float, float, float]' = (1.0, 0.0, 0.0), y_axis: 'tuple[float, float, float]' = (0.0, 1.0, 0.0), z_axis: 'tuple[float, float, float]' = (0.0, 0.0, 1.0))