Scene and artifacts

Validated Scene documents, resources, portable archives, and renderable artifact compilation.

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

Modules

Symbol	Import	Summary
scene	from cadflow import scene	Scene compilation and archive domain facade.

Classes

Symbol	Import	Summary
ArchiveInfo	from cadflow.scene import ArchiveInfo	ArchiveInfo(members: 'Mapping[str, bytes]', input_size: 'int | None', canonical_size: 'int', used_deflate: 'bool')
CanonicalEdgeBlock	from cadflow import CanonicalEdgeBlock	CanonicalEdgeBlock(entity_id: 'str', render_key: 'bytes', block_bytes: 'bytes', position_keys: 'tuple[bytes, ...]', positions: 'tuple[tuple[float, float, float], ...]', segments: 'tuple[tuple[int, int], ...]')
CanonicalTriangleBlock	from cadflow import CanonicalTriangleBlock	CanonicalTriangleBlock(entity_id: 'str', render_key: 'bytes', block_bytes: 'bytes', vertex_keys: 'tuple[bytes, ...]', positions: 'tuple[tuple[float, float, float], ...]', normals: 'tuple[tuple[float, float, float], ...]', triangles: 'tuple[tuple[int, int, int], ...]')
CompiledScenePackage	from cadflow import CompiledScenePackage	CompiledScenePackage(manifest: 'Mapping[str, Any]', blobs: 'Mapping[str, bytes]')
EntityDocument	from cadflow.scene import EntityDocument	EntityDocument(value: 'DocumentValue | Mapping[str, Any]') -> 'None'
GlbInfo	from cadflow.scene import GlbInfo	GlbInfo(kind: "Literal['triangle', 'line']", vertex_count: 'int', index_count: 'int', primitive_count: 'int', decoded_buffer_bytes: 'int', position_bounds: 'tuple[tuple[float, float, float], tuple[float, float, float]]')
NormalizedProductDocument	from cadflow.scene import NormalizedProductDocument	NormalizedProductDocument(value: 'DocumentValue | Mapping[str, Any]') -> 'None'
PresentationDocument	from cadflow.scene import PresentationDocument	PresentationDocument(value: 'DocumentValue | Mapping[str, Any]') -> 'None'
RenderEdgeMesh	from cadflow import RenderEdgeMesh	RenderEdgeMesh(positions: 'tuple[tuple[float, float, float], ...]', indices: 'tuple[int, ...]', groups: 'tuple[RenderGroup, ...]', bounds: 'tuple[tuple[float, float, float], tuple[float, float, float]]', blocks: 'tuple[CanonicalEdgeBlock, ...]', degenerate_entity_ids: 'tuple[str, ...]')
RenderGroup	from cadflow import RenderGroup	RenderGroup(entity_id: 'str', first_index: 'int', index_count: 'int')
RenderMesh	from cadflow import RenderMesh	RenderMesh(positions: 'tuple[tuple[float, float, float], ...]', normals: 'tuple[tuple[float, float, float], ...]', indices: 'tuple[int, ...]', groups: 'tuple[RenderGroup, ...]', bounds: 'tuple[tuple[float, float, float], tuple[float, float, float]]', blocks: 'tuple[CanonicalTriangleBlock, ...]')
SceneCompileOptions	from cadflow import SceneCompileOptions	SceneCompileOptions(linear_tolerance: 'float' = 0.1, angular_tolerance: 'float' = 0.08, embed_source: 'bool' = False, embed_presentation: 'bool' = False)
SceneDocument	from cadflow.scene import SceneDocument	SceneDocument(value: 'DocumentValue | Mapping[str, Any]') -> 'None'
SceneResourceLimits	from cadflow.scene import SceneResourceLimits	SceneResourceLimits(zip_members: 'int' = 50000, input_archive_bytes: 'int' = 268435456, canonical_archive_bytes: 'int' = 268435456, total_uncompressed_bytes: 'int' = 1073741824, one_member_bytes: 'int' = 268435456, scene_json_bytes: 'int' = 33554432, entity_json_bytes: 'int' = 67108864, model_json_bytes: 'int' = 67108864, presentation_json_bytes: 'int' = 8388608, compression_ratio: 'int' = 100, json_depth: 'int' = 64, json_string_bytes: 'int' = 1048576, uri_bytes: 'int' = 1024, structural_id_bytes: 'int' = 4096, definitions: 'int' = 25000, nodes: 'int' = 100000, assets_per_kind: 'int' = 25000, appearances: 'int' = 25000, connectors: 'int' = 100000, cameras: 'int' = 1000, hierarchy_depth: 'int' = 256, forwarded_connector_depth: 'int' = 64, entities_per_sidecar: 'int' = 500000, entities_total: 'int' = 2000000, triangle_vertices_per_asset: 'int' = 2000000, triangle_vertices_total: 'int' = 10000000, triangles_per_asset: 'int' = 2000000, triangles_total: 'int' = 10000000, line_vertices_per_asset: 'int' = 2000000, line_vertices_total: 'int' = 10000000, line_segments_per_asset: 'int' = 2000000, line_segments_total: 'int' = 10000000, static_decoded_buffer_bytes: 'int' = 536870912)
SceneRoot	from cadflow import SceneRoot	SceneRoot(root_id: 'str', value: 'Solid | Compound | Part | Assembly', transform: 'Placement' = <factory>, source_element_id: 'str | None' = None)
SceneSource	from cadflow import SceneSource	SceneSource(kind: 'str', source_id: 'str | None' = None, graph_id: 'str | None' = None, artifact_hash: 'str | None' = None, format: 'str | None' = None, artifact_bytes: 'bytes | None' = None, _graph: 'OperationGraph | None' = None, _source_files: "tuple['_EmbeddedSourceFile', ...]" = ())
SceneValidationIssue	from cadflow.scene import SceneValidationIssue	SceneValidationIssue(severity: 'str', code: 'str', path: 'str', message: 'str', phase: 'str')
SceneValidationReport	from cadflow.scene import SceneValidationReport	SceneValidationReport(issues: 'tuple[SceneValidationIssue, ...]' = ())

Exceptions

Symbol	Import	Summary
SceneContractError	from cadflow.scene import SceneContractError	Raised by assert helpers with the complete deterministic report.

Functions

Symbol	Import	Summary
assert_entity_asset	from cadflow.scene import assert_entity_asset	Public function in this domain.
assert_normalized_product	from cadflow.scene import assert_normalized_product	Public function in this domain.
assert_presentation	from cadflow.scene import assert_presentation	Public function in this domain.
assert_scene_manifest	from cadflow.scene import assert_scene_manifest	Public function in this domain.
assert_scene_package	from cadflow.scene import assert_scene_package	Public function in this domain.
build_edge_mesh	from cadflow import build_edge_mesh	Public function in this domain.
build_render_mesh	from cadflow import build_render_mesh	Public function in this domain.
cad_direction_to_gltf	from cadflow import cad_direction_to_gltf	Public function in this domain.
cad_to_gltf	from cadflow import cad_to_gltf	Convert CAD mm/+Z coordinates to glTF m/+Y coordinates.
canonical_archive_size	from cadflow.scene import canonical_archive_size	Compute the exact stored ZIP envelope size from names and payload sizes.
canonical_json_bytes	from cadflow.scene import canonical_json_bytes	Return RFC 8785 JCS bytes, rejecting values outside the JCS domain.
canonical_json_hash	from cadflow.scene import canonical_json_hash	Return a lowercase Scene content hash over canonical JSON bytes.
canonical_zip_bytes	from cadflow.scene import canonical_zip_bytes	Encode exact canonical stored ZIP bytes for a validated member mapping.
compile_scene	from cadflow import compile_scene	Public function in this domain.
compute_scene_revision	from cadflow.scene import compute_scene_revision	Compute the two-pass Scene revision with the top-level field omitted.
export_scene	from cadflow import export_scene	Public function in this domain.
json_resource_issues	from cadflow.scene import json_resource_issues	Return deterministic JSON-domain resource issues for boundary probes.
load_contract_artifact	from cadflow.scene import load_contract_artifact	Load exact packaged contract bytes by a safe package-relative path.
parse_canonical_json	from cadflow.scene import parse_canonical_json	Parse JSON and require the input bytes to already be exact JCS bytes.
parse_strict_json	from cadflow.scene import parse_strict_json	Parse one strict UTF-8 JSON value while rejecting duplicate keys.
preflight_aggregate_compression_ratio	from cadflow.scene import preflight_aggregate_compression_ratio	Validate the aggregate compression-ratio predicate without inflating data.
preflight_archive_member_sizes	from cadflow.scene import preflight_archive_member_sizes	Validate declared archive sizes before allocating or reading payloads.
preflight_glb	from cadflow.scene import preflight_glb	Validate exact Scene GLB JSON/BIN layout before a renderer sees bytes.
preflight_glb_counts	from cadflow.scene import preflight_glb_counts	Validate kind-specific accessor counts before decoding GLB buffers.
preflight_input_archive_size	from cadflow.scene import preflight_input_archive_size	Validate a transported archive length before reading that many bytes.
preflight_member_compression_ratio	from cadflow.scene import preflight_member_compression_ratio	Validate one member compression-ratio predicate before inflation.
preflight_resource_count	from cadflow.scene import preflight_resource_count	Validate one non-negative resource count against the named profile limit.
preflight_unpacked_scene	from cadflow.scene import preflight_unpacked_scene	Preflight and immutably read an unpacked scene without following links.
preflight_zip_bytes	from cadflow.scene import preflight_zip_bytes	Validate and decode an allowlisted stored/deflate Scene ZIP archive.
profile_cross	from cadflow.scene import profile_cross	Evaluate the profile cross product in fixed binary64 operation order.
profile_f32	from cadflow.scene import profile_f32	Convert one value with the profile's binary32 and zero-sign rules.
profile_f32_bits	from cadflow.scene import profile_f32_bits	Convert one binary64 value to canonical profile binary32 bits.
profile_normalize	from cadflow.scene import profile_normalize	Normalize a vector using the profile's fixed binary64/binary32 steps.
resource_count_issues	from cadflow.scene import resource_count_issues	Return early collection and graph-depth resource issues.
solid_asset_bounds	from cadflow import solid_asset_bounds	Public function in this domain.
validate_entity_asset	from cadflow.scene import validate_entity_asset	Public function in this domain.
validate_normalized_product	from cadflow.scene import validate_normalized_product	Public function in this domain.
validate_presentation	from cadflow.scene import validate_presentation	Public function in this domain.
validate_scene_manifest	from cadflow.scene import validate_scene_manifest	Public function in this domain.
validate_scene_package	from cadflow.scene import validate_scene_package	Public function in this domain.
with_scene_revision	from cadflow.scene import with_scene_revision	Return a deep copy carrying its computed Scene revision.
write_line_glb	from cadflow import write_line_glb	Public function in this domain.
write_triangle_glb	from cadflow import write_triangle_glb	Public function in this domain.

Constants

Symbol	Import	Summary
BASE_LIMITS	from cadflow.scene import BASE_LIMITS	SceneResourceLimits(zip_members: 'int' = 50000, input_archive_bytes: 'int' = 268435456, canonical_archive_bytes: 'int' = 268435456, total_uncompressed_bytes: 'int' = 1073741824, one_member_bytes: 'int' = 268435456, scene_json_bytes: 'int' = 33554432, entity_json_bytes: 'int' = 67108864, model_json_bytes: 'int' = 67108864, presentation_json_bytes: 'int' = 8388608, compression_ratio: 'int' = 100, json_depth: 'int' = 64, json_string_bytes: 'int' = 1048576, uri_bytes: 'int' = 1024, structural_id_bytes: 'int' = 4096, definitions: 'int' = 25000, nodes: 'int' = 100000, assets_per_kind: 'int' = 25000, appearances: 'int' = 25000, connectors: 'int' = 100000, cameras: 'int' = 1000, hierarchy_depth: 'int' = 256, forwarded_connector_depth: 'int' = 64, entities_per_sidecar: 'int' = 500000, entities_total: 'int' = 2000000, triangle_vertices_per_asset: 'int' = 2000000, triangle_vertices_total: 'int' = 10000000, triangles_per_asset: 'int' = 2000000, triangles_total: 'int' = 10000000, line_vertices_per_asset: 'int' = 2000000, line_vertices_total: 'int' = 10000000, line_segments_per_asset: 'int' = 2000000, line_segments_total: 'int' = 10000000, static_decoded_buffer_bytes: 'int' = 536870912)
SCHEMA_FILES	from cadflow.scene import SCHEMA_FILES	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)