Skip to content

fix: add zOffsetFromSurface property to cadmodel documentation #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rushabhcodes merged 2 commits into from
Dec 14, 2025
Merged

fix: add zOffsetFromSurface property to cadmodel documentation #388

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
123b4de
fix: add zOffsetFromSurface property to cadmodel documentation
rushabhcodes Dec 14, 2025
bff142d
fix: add WRL format support to cadmodel documentation
rushabhcodes Dec 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions docs/elements/cadmodel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import CircuitPreview from "@site/src/components/CircuitPreview"

## Repositioning the Model

You can use `positionOffset` and `rotationOffset` to reposition the model.
You can use `positionOffset`, `rotationOffset`, and `zOffsetFromSurface` to reposition the model.

<CircuitPreview
defaultView="3d"
Expand All @@ -59,6 +59,33 @@ You can use `positionOffset` and `rotationOffset` to reposition the model.
`}
/>

### Z-Offset from Surface

Use `zOffsetFromSurface` to control the vertical distance of the model from the PCB surface. This is useful for components that need to be positioned above or below the board surface.

<CircuitPreview
defaultView="3d"
hidePCBTab
hideSchematicTab
browser3dView={false}
code={`
export default () => (
<board>
<chip
name="U1"
footprint="soic8"
cadModel={
<cadmodel
zOffsetFromSurface="2mm"
modelUrl="https://modelcdn.tscircuit.com/jscad_models/soic8.glb"
/>
}
/>
</board>
)
`}
/>

## Importing local GLB models

<CircuitPreview
Expand Down Expand Up @@ -131,4 +158,17 @@ The following model file formats are supported:
- GLTF
- OBJ
- STEP
- STL
- STL
- WRL

## Properties

| Property | Type | Description |
|----------|------|-------------|
| `modelUrl` | `string` | URL to the 3D model file (GLB, GLTF, OBJ, STL, STEP, WRL) |
| `stepUrl` | `string` | URL to a STEP model file for export purposes |
| `positionOffset` | `{x: number, y: number, z: number}` | Offset the model position from the component center |
| `rotationOffset` | `number \| {x: number, y: number, z: number}` | Rotate the model (number = Z-axis rotation in degrees) |
| `zOffsetFromSurface` | `Distance` | Vertical offset from the PCB surface (e.g., "2mm", "0.1in") |
| `size` | `{x: number, y: number, z: number}` | Scale the model size |
| `modelUnitToMmScale` | `Distance` | Scale factor to convert model units to millimeters |