Skip to content

Add cad model board direction and pcbRotationOffset props #617

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
seveibar merged 1 commit into from
Mar 12, 2026
+47 −0
Merged

Add cad model board direction and pcbRotationOffset props #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions generated/COMPONENT_TYPES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ export const rotationPoint3 = z.object({
y: z.union([z.number(), z.string()]),
z: z.union([z.number(), z.string()]),
})
export const cadModelAxisDirections = [
"x+",
"x-",
"y+",
"y-",
"z+",
"z-",
] as const
export interface CadModelBase {
rotationOffset?:
| number
Expand All @@ -21,6 +29,8 @@ export interface CadModelBase {
}
size?: { x: number | string; y: number | string; z: number | string }
modelUnitToMmScale?: Distance
modelBoardNormalDirection?: CadModelAxisDirection
pcbRotationOffset?: number
zOffsetFromSurface?: Distance
showAsTranslucentModel?: boolean
}
Expand All @@ -29,6 +39,8 @@ export const cadModelBase = z.object({
positionOffset: point3.optional(),
size: point3.optional(),
modelUnitToMmScale: distance.optional(),
modelBoardNormalDirection: cadModelAxisDirection.optional(),
pcbRotationOffset: z.number().optional(),
zOffsetFromSurface: distance.optional(),
showAsTranslucentModel: z.boolean().optional(),
})
Expand Down
2 changes: 2 additions & 0 deletions generated/PROPS_OVERVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,8 @@ export interface CadModelBase {
}
size?: { x: number | string; y: number | string; z: number | string }
modelUnitToMmScale?: Distance
modelBoardNormalDirection?: CadModelAxisDirection
pcbRotationOffset?: number
zOffsetFromSurface?: Distance
showAsTranslucentModel?: boolean
}
Expand Down
17 changes: 17 additions & 0 deletions lib/common/cadModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ export const rotationPoint3 = z.object({
z: z.union([z.number(), z.string()]),
})

export const cadModelAxisDirections = [
"x+",
"x-",
"y+",
"y-",
"z+",
"z-",
] as const

export type CadModelAxisDirection = (typeof cadModelAxisDirections)[number]

export const cadModelAxisDirection = z.enum(cadModelAxisDirections)

export interface CadModelBase {
rotationOffset?:
| number
Expand All @@ -22,6 +35,8 @@ export interface CadModelBase {
}
size?: { x: number | string; y: number | string; z: number | string }
modelUnitToMmScale?: Distance
modelBoardNormalDirection?: CadModelAxisDirection
pcbRotationOffset?: number
zOffsetFromSurface?: Distance
showAsTranslucentModel?: boolean
}
Expand All @@ -31,6 +46,8 @@ export const cadModelBase = z.object({
positionOffset: point3.optional(),
size: point3.optional(),
modelUnitToMmScale: distance.optional(),
modelBoardNormalDirection: cadModelAxisDirection.optional(),
pcbRotationOffset: z.number().optional(),
zOffsetFromSurface: distance.optional(),
showAsTranslucentModel: z.boolean().optional(),
})
Expand Down
16 changes: 16 additions & 0 deletions tests/cadmodel.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,19 @@ test("cadmodel accepts showAsTranslucentModel", () => {

expect(parsed.showAsTranslucentModel).toBe(true)
})

test("cadmodel accepts modelBoardNormalDirection and pcbRotationOffset", () => {
const raw: CadModelPropsInput = {
modelUrl: "https://example.com/model.stl",
modelBoardNormalDirection: "z+",
pcbRotationOffset: 90,
}

const parsed = cadmodelProps.parse(raw) as Exclude<
CadModelPropsInput,
null | string
>

expect(parsed.modelBoardNormalDirection).toBe("z+")
expect(parsed.pcbRotationOffset).toBe(90)
})
Comment on lines +117 to +131
Copy link
Contributor

@graphite-app graphite-app bot Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test file violates the rule that a *.test.ts file may have AT MOST one test(...) function. The file already contains at least one test() function (as evidenced by the existing test ending at line 115), and this diff adds a second test() function starting at line 117. To fix this violation, the new test should be moved to a separate numbered test file, such as 'cadmodel2.test.ts' or similar.

Spotted by Graphite (based on custom rule: Custom rule)

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

Loading