Reference
Every property, Blueprint node, console variable and command, and which of them take effect at run time. Live means it applies without reopening the file; read at load means the file must be opened again for it to matter, because it decides what is built.
Read when the file opens
| Property | Default | When | What it does |
|---|---|---|---|
| Load Mesh | on | read at load | Whether parts are meshed. |
| Load Edges | on | read at load | Build the edges where faces meet. |
| Load Curves | on | read at load | Build the file's free curves. |
| Load Isocurves | on | read at load | Build each surface's isocurves. |
| Load Unreachable Geometry | off | read at load | Bodies the file's tree never places. |
| Generate Levels Of Detail | on | read at load | Simplified copies of each part. |
| Draw Before Levels Of Detail | off | read at load | Show the document before the levels are built. |
| Use Vertex Color Buffer | on | read at load | Four bytes a vertex, so parts can be recoloured later. |
| Generate Texture Coordinates | off | read at load | World-scale UVs. |
| Keep Document For Queries | on | read at load | Keep the tree open for names, properties and queries. |
| Express Schema Paths | empty | read at load | Extra EXPRESS schemas; an entry may be a directory. |
| Generate Collision | off | read at load | Fit one convex hull per part. |
| Hull Triangle Budget | 255 | read at load | The most triangles a hull may have. |
| Max Hulls Per Part | 1 | read at load | How many convex pieces a concave part may be decomposed into. 1 is one hull per part. |
| Use Complex Collision As Simple | off | read at load | Collide with the document's own triangles, for a document that does not simulate. |
| Surface Proxy Mesh Cells surface component only | 0 | read at load | A coarse mesh per surfaced part for ray tracing and the distance field. Never drawn. |
Drawing
Where a setter is named under a property, write it through that setter from code: assigning the property alone leaves the render thread drawing what it drew before.
| Property | Default | When | What it does |
|---|---|---|---|
| Draw Mesh | on | live | Draw the faces. Off leaves the lines alone on screen. Set Draw Mesh |
| Draw Edges, Draw Curves, Draw Isocurves | off | live | Show each family of lines. Only shows what the load built. Set Draw Curve Kind |
| Draw Lines On Top | off | live | The x-ray wireframe. Set Draw Lines On Top |
| Line Thickness | 1 px | live | Line width in pixels. Set Line Thickness |
| Line Width Scale | 0.005 | live | A line's worth in world units; zero leaves pixels alone. |
| Edge / Curve / Isocurve Color Mode | custom, object, custom | live | The part's own colour, or one colour for the kind. |
| Edge / Curve / Isocurve Color | black, blue, black | live | The colour used where the mode says custom. |
| Materials | plugin default | live | The material slots, as on any primitive. |
| Distance Field Resolution Scale | 0 | live | Builds the field in the background; zero removes it. Set Distance Field Resolution Scale, Rebuild Distance Field |
| Edge / Curve / Isocurve Source | polylines | read at load | Which description each family of lines is built from. |
| Curve Tolerance | 0 | read at load | How far a flattened exact curve may stray, in world units. |
The calls
| Group | Functions |
|---|---|
| Loading | Load CAD File, Load CAD File Async, Cancel Load, Is Loading, Get Load Phase, Get Load Progress, Get Load Diagnostics, On Load Progress, Pick File, Pick And Load, Pick Save Path, Load String |
| The tree | Get Num Nodes, Get Node, Get Root Nodes, Get Node Range, Get Node Details, Get Node Bounds, Get Node Transform, Get Metres Per Unit, Query Nodes |
| Per part | Set Node Transform, Set Node Visible, Set All Nodes Visible, Is Node Visible, Get Visible Node Count, Set Node Color, Get Node Color, Set Node Opacity, Set Node Style, Set Node Metallic, Set Node Roughness, Set Node Emissive, Set Node Material Slot, Get Node Material |
| Lines | Set Draw Curve Kind, Set Line Thickness, Set Draw Lines On Top, Set Node Line Highlight, Clear Node Line Highlight |
| Picking | Trace Node, Get Hit Node |
| Collision | Get Collision Element Count, Get Collision Element, Get Collision Element Hull, Get Collision Element Piece Count, Get Collision Element Piece |
| Measuring | Get Last Frame Stats, Get Build Milliseconds, Get Nodes Meshed At Load, Get Nodes Lined From Trims, Get Surfaces |
| Lighting | Set Distance Field Resolution Scale, Rebuild Distance Field |
All of these are on the component. The actors forward loading only, so anything else is reached through the actor's Document.
Drawing and culling
| Variable | Default | What it does |
|---|---|---|
r.Cadaclysm.LodScreenError | 0.0001 | How far a level of detail may move the surface, as a fraction of screen radius. 0 draws full detail. |
r.Cadaclysm.ShadowLod | -1 | Which level shadows are cast from: -1 the coarsest (bounded by ShadowLodError), 0 full detail, or a level. |
r.Cadaclysm.ShadowLodError | 0 | With ShadowLod -1, how far a shadow's level may move the surface, as a fraction of the part's radius. 0 takes the coarsest whatever it loses. |
r.Cadaclysm.LodCluster | 0 | How many neighbouring parts share one level. 0 selects per part. |
r.Cadaclysm.MinScreenRadius | 0 | Parts smaller than this fraction of the screen are not drawn. |
r.Cadaclysm.Occlusion | 0 | How many of the largest parts to use as occluders. |
r.Cadaclysm.Indirect | 1 | Compact the visible indices on the card and draw them as one call. |
r.Cadaclysm.MergeRuns | 1 | Let neighbouring parts that agree share a draw. |
r.Cadaclysm.SingleBatch | 0 | Draw the document as one batch, with no per-part culling. For measuring. |
r.Cadaclysm.DepthPrepass | 1 | Draw in the depth prepass. Normally required. |
r.Cadaclysm.NodeOrder | 0 | How parts are laid into the index buffer, so neighbours can share a draw. Read at load. |
r.Cadaclysm.LogCulling | 0 | Log how many parts each view drew, out of how many exist. |
The surface path
| Variable | Default | What it does |
|---|---|---|
r.Cadaclysm.Surface.SagittaPx | 0.3 | How far a cell's chord may sit from the true surface, in screen pixels. |
r.Cadaclysm.Surface.MaxGrid | 64 | The most cells one face may take, as the side of a square. |
r.Cadaclysm.Surface.TrimCellPx | 16 | How far apart the cells of a trimmed face may be, in pixels. |
r.Cadaclysm.Surface.SubCellPx | 2 | How small a cell the trim crosses is split to. |
r.Cadaclysm.Surface.Cull | 2 | What an unseen face gets: nothing (1), one cell (2), or its full density (0). |
r.Cadaclysm.Surface.VertexBudget | 4M | How many vertices one frame's tessellation may append. |
r.Cadaclysm.Surface.Retries | 2 | How many times a frame over the vertex budget is tessellated again, coarser, before it is drawn. 0 leaves it to the next frame. |
r.Cadaclysm.Surface.StillFrames | 12 | After how many still frames the tessellation is reused rather than redone. 0 is off. |
r.Cadaclysm.Surface.ShadowViews | 4 | How many shadow views get a tessellation of their own. |
r.Cadaclysm.Surface.ShadowDensity | 0.25 | A shadow view's density, as a fraction of the shadow map's resolution. |
r.Cadaclysm.Surface.ShadowVertexBudget | 1M | The vertex ceiling for one shadow view. |
r.Cadaclysm.Surface.TrimBleed | 0.4 | How far past its trim a face may be drawn, as a fraction of a cell, where the trim lies on an edge shared with another face. Closes the seam between two faces that meet; never applied at a boundary. 0 is off. |
r.Cadaclysm.Surface.TrimGrid | 1 | Trim tests through the per-face grid (1) or by walking every segment (0). Both exact. |
r.Cadaclysm.Surface.DebugCells | 0 | Colour what was tessellated instead of the parts: a shade a cell, blue for a whole cell and orange for one the trim cuts (1), or a colour a face record, which shows a winding face as the tiles it was cut into (2), or both: a colour a tile, a shade of it a cell (3). |
r.Cadaclysm.Surface.DebugUntrimmed | 0 | Draw every face uncut, over its whole parameter rectangle, so what the trim cuts away can be seen. Pair it with the part’s edges, which are its trim loops. |
Lines, light and the distance field
| Variable | Default | What it does |
|---|---|---|
r.Cadaclysm.DistanceField.SliceMilliseconds | — | Target wall time for one build submission; slices are sized to hit it. |
r.Cadaclysm.DistanceField.AsyncCompute | — | Build on the async compute queue, interleaved with drawing. |
r.Cadaclysm.DistanceField.MaxCells, MaxWorkMillions, MaxBinEntries, MaxSliceBricks | — | Ceilings on a build's size and work; over them it coarsens, halves or refuses. |
r.Cadaclysm.DistanceField.LodErrorVoxels | — | How far a level of detail may move the surface and still be measured in place of full detail. |
r.Cadaclysm.DistanceField.WindingExactCells, WindingBeta, WindingCoarsen | — | How the inside/outside sign is computed: accuracy against cost. |
r.Cadaclysm.LinesAfterTonemap | 0 | Draw lines after tonemapping, past temporal anti-aliasing. |
r.Cadaclysm.LineOcclusionBias | 0.002 | How much nearer the faces must be before a line counts as covered. |
r.Cadaclysm.LineOcclusionSlopeMax | 0.02 | The most the slope-scaled part of that test may allow, where it is used: lines drawn after tonemapping, or LineFacePlanes 0. |
r.Cadaclysm.LineFacePlanes | 1 | Draw a line over the face it lies on by that face’s own plane: 1 from the G-buffer normal or the depth around the pixel, 2 from the depth alone, 0 the older slope allowance. |
r.Cadaclysm.LogLumen | 0 | Log once whether a document is visible in the Lumen scene. |
Nanite and diagnostics
| Variable | Default | What it does |
|---|---|---|
r.Cadaclysm.Nanite | 0 | Encode documents as Nanite: 0 where an actor asks, 1 every document, -1 none. |
r.Cadaclysm.NaniteOnlyMesh | 0 | Build each part's mesh straight into its render buffers. Faster to load; no collision or lightmap UVs. |
r.Cadaclysm.NaniteLevels, NaniteSimpleIndices, NaniteEngineBuilder | — | Diagnostics for the runtime encoder: coarser levels, index form, and the engine's builder for comparison. |
r.Cadaclysm.PartTriangleSkip, PartTriangleCap | 0 | Draw and encode only a window of each part's triangles. A diagnostic. |
For trying things without a Blueprint
| Command | What it does |
|---|---|
Cadaclysm.Draw <file> [options] | Load a file into the current level and draw it, without touching a Blueprint. |
Cadaclysm.Shot <file> <out.png> | Load a file, frame it and write a picture. The harness these pages' pictures come from. |
Cadaclysm.Pick, Cadaclysm.TimePicking | Trace against the document under the cursor, and time it. |
Cadaclysm.TimeRebuild, Cadaclysm.Repeats | Time a rebuild of the render state; place a document many times over. |
Cadaclysm.FarSweep | Draw a document at increasing distances from the origin, to see precision give way. |
Cadaclysm.MakeNanite, Cadaclysm.NanitePart, Cadaclysm.NaniteCube, Cadaclysm.NaniteSphere, Cadaclysm.NaniteRoundTrip, Cadaclysm.MakeMaterialNanite, Cadaclysm.DrawNanite | The Nanite encoder's own probes. |
What to place
| Class | What it is |
|---|---|
UCadaclysmComponent | The document, drawn from triangles. Everything lives here. |
UCadaclysmSurfaceComponent | The document, drawn from its surfaces and never meshed. Adds Surface Proxy Mesh Cells. |
ACadaclysmActor | An actor with the component on it, as Document. |
ACadaclysmSurfaceActor | The same with the surface component. |
ACadaclysmPartBodiesActor | The single primitive plus one physics body per part. |
ACadaclysmStaticMeshActor | Every part as its own static mesh component, optionally Nanite. |
UCadaclysmLineComponent | The lines on their own, for a project that draws them separately. |
Worth knowing before you build on it
Materials and the surface component. A document drawn from surfaces draws in the plugin's own material whatever the slots say; the two paths cannot share a material graph.
Collision is one convex hull per part, fitted at load. Concave parts are not decomposed, and the fit cannot be redone without reloading.
Ray tracing needs the coarse proxy. Without Surface Proxy Mesh Cells, a surfaced part is absent from traced shadows, Lumen's hardware path and the distance field.
A surfaced face is cut to its trim curves in the material, from a distance carried on the vertices — so the cut lands within a fraction of a cell of the exact edge rather than exactly on it. Where two faces meet, both are drawn a fraction of a cell past the shared edge so they overlap instead of leaving a seam (r.Cadaclysm.Surface.TrimBleed); at a real boundary — a hole’s rim, the outline of a letter, the open side of a sheet — nothing is drawn past the trim at all.
Unreal Engine 5.8, on Windows x64, Linux x86-64 and Android arm64 today. Surfaces need shader model 6 (DirectX 12, or Vulkan SM6); below it, and on every Android renderer, documents draw from their triangles. Lines need SM5, so Android’s mobile renderer draws documents without them. Pick CAD File has no dialog on Android; on Linux it opens the desktop’s own through the file-chooser portal. Mac and iOS are not supported.