jscad-electronics 0.0.151 → 0.0.153

package/README.md

@@ -71,6 +71,41 @@ Most components accept parameters for customization. For example:
 
 Refer to the individual component files for available customization options.
 
+### Flexible screens
+
+`FlexScreen` combines a parameterized display with an FPC cable. Screen size
+can be supplied directly or derived from a diagonal and aspect ratio, and the
+built-in mounting presets place the display above, below, or at a right angle
+to the board plane.
+
+```tsx
+import { FlexScreen } from "jscad-electronics"
+
+<FlexScreen
+  diagonal={50}
+  aspectRatio="16:9"
+  orientation="foldedToFaceBelowBoard"
+  flexCableLength={38}
+  flexCableWidth={10}
+  conductorCount={10}
+  distanceBelowBoard={9}
+  foldDistanceFromConnector={8}
+  foldOutset={5}
+/>
+```
+
+Use `sitsFlat` when the display and cable continue in the same direction.
+`foldedToFaceAboveBoard` and `foldedToFaceBelowBoard` create true 180-degree
+folds, while `foldedToRightAngleAboveBoard` and
+`foldedToRightAngleBelowBoard` create 90-degree bends. The downward 180-degree
+fold starts on top of the board and turns over its edge.
+
+For 180-degree folds, `distanceAboveBoard` or `distanceBelowBoard` sets the
+final screen backplane independently of `foldDistanceFromConnector` and
+`foldOutset`, which control where the loop begins and how far it projects past
+the board edge. Every orientation is also available as a boolean shortcut, for
+example `<FlexScreen sitsFlat />` or `<FlexScreen foldsBelowBoard />`.
+
 ## Integration with tscircuit
 
 jscad-electronics is designed to work seamlessly with tscircuit. You can use these 3D models in your tscircuit projects to create accurate 3D representations of your PCB designs just by

package/dist/index.d.ts

@@ -590,6 +590,111 @@ interface ScreenProps {
 declare const Screen: ({ width, height, thickness, bezelInset, bezelDepth, screenColor, bezelColor, screenWidth, screenHeight, offset, }: ScreenProps) => react_jsx_runtime.JSX.Element;
 declare const Display: ({ width, height, thickness, bezelInset, bezelDepth, screenColor, bezelColor, screenWidth, screenHeight, offset, }: ScreenProps) => react_jsx_runtime.JSX.Element;
 
+type Rotation3 = [number | string, number | string, number | string];
+type FlexScreenOrientation = "sitsFlat" | "sitsFlatBelowBoard" | "foldedToFaceAboveBoard" | "foldedToFaceBelowBoard" | "foldedToRightAngleAboveBoard" | "foldedToRightAngleBelowBoard";
+type FlexScreenAspectRatio = number | `${number}:${number}` | readonly [number, number];
+interface FlexScreenProps {
+    /** Explicit screen width. If height is omitted, it is derived from the ratio. */
+    width?: number;
+    /** Explicit screen height. If width is omitted, it is derived from the ratio. */
+    height?: number;
+    /** Screen diagonal. Used with the ratio unless one other dimension is supplied. */
+    diagonal?: number;
+    /** Width-to-height ratio. Accepts 1.777, "16:9", or [16, 9]. */
+    aspectRatio?: FlexScreenAspectRatio;
+    /** Alias for aspectRatio. aspectRatio takes precedence when both are supplied. */
+    ratio?: FlexScreenAspectRatio;
+    /** Diagonal used when width, height, and diagonal are all omitted. */
+    defaultDiagonal?: number;
+    orientation?: FlexScreenOrientation;
+    /** Boolean orientation shortcuts for footprint/configuration builders. */
+    sitsFlat?: boolean;
+    sitsFlatBelowBoard?: boolean;
+    foldedToFaceAboveBoard?: boolean;
+    foldedToFaceBelowBoard?: boolean;
+    /** Concise aliases for the 180-degree face-above/face-below folds. */
+    foldsAboveBoard?: boolean;
+    foldsBelowBoard?: boolean;
+    foldedToRightAngleAboveBoard?: boolean;
+    foldedToRightAngleBelowBoard?: boolean;
+    screenThickness?: number;
+    bezelInset?: number;
+    bezelDepth?: number;
+    activeAreaWidth?: number;
+    activeAreaHeight?: number;
+    screenColor?: string;
+    bezelColor?: string;
+    showScreen?: boolean;
+    /** Centerline length of the modeled cable route. */
+    flexCableLength?: number;
+    flexCableWidth?: number;
+    flexCableThickness?: number;
+    flexCableColor?: string;
+    conductorCount?: number;
+    conductorPitch?: number;
+    conductorWidth?: number;
+    conductorThickness?: number;
+    conductorColor?: string;
+    cableEdgeMargin?: number;
+    exposedContactLength?: number;
+    showConductors?: boolean;
+    showFlexCable?: boolean;
+    showStiffeners?: boolean;
+    stiffenerLength?: number;
+    stiffenerThickness?: number;
+    stiffenerColor?: string;
+    /** Radius of the 90-degree cable bend in right-angle presets. */
+    bendRadius?: number;
+    /** Number of straight segments used to approximate a 90-degree bend. */
+    bendSegments?: number;
+    /** Straight cable length after the bend before the screen attachment. */
+    rightAngleVerticalLead?: number;
+    /** Screen backplane distance above the board for a 180-degree upward fold. */
+    distanceAboveBoard?: number;
+    /** Screen backplane distance below the board for a 180-degree downward fold. */
+    distanceBelowBoard?: number;
+    /** Straight distance from the connector to the start of a 180-degree fold. */
+    foldDistanceFromConnector?: number;
+    /** Maximum distance the 180-degree loop extends beyond the fold start. */
+    foldOutset?: number;
+    /** Number of straight segments used to approximate a 180-degree fold. */
+    foldSegments?: number;
+    screenGap?: number;
+    /** Board reference used to place above/below presets. The board is not rendered. */
+    boardTopZ?: number;
+    boardThickness?: number;
+    boardClearance?: number;
+    cableStartX?: number;
+    cableStartY?: number;
+    /** Overrides the preset-derived cable centerline Z at the connector end. */
+    cableStartZ?: number;
+    cableLateralOffset?: number;
+    /** Added after the orientation preset computes the screen attachment pose. */
+    screenOffset?: {
+        x?: number;
+        y?: number;
+        z?: number;
+    };
+    /** Replaces the orientation preset's screen rotation. */
+    screenRotation?: Rotation3;
+    /** Rotates the complete assembly around its cable origin. */
+    rotation?: Rotation3;
+    /** Translates the complete assembly after rotation. */
+    offset?: {
+        x?: number;
+        y?: number;
+        z?: number;
+    };
+}
+interface ResolvedFlexScreenSize {
+    width: number;
+    height: number;
+    diagonal: number;
+    aspectRatio: number;
+}
+declare const resolveFlexScreenSize: ({ width, height, diagonal, aspectRatio, ratio, defaultDiagonal, }: Pick<FlexScreenProps, "width" | "height" | "diagonal" | "aspectRatio" | "ratio" | "defaultDiagonal">) => ResolvedFlexScreenSize;
+declare const FlexScreen: (props: FlexScreenProps) => react_jsx_runtime.JSX.Element;
+
 interface JSTZH1_5mmProps {
     numPins?: number;
     showPins?: boolean;
@@ -886,4 +991,4 @@ interface GullWingBodyProps {
  */
 declare const GullWingBody: ({ bodyWidth, bodyLength, bodyHeight, pads, leadThickness, leadHeightRatio, }: GullWingBodyProps) => react_jsx_runtime.JSX.Element;
 
-export { A01005, A0201, A0402, A0603, A0805, A1206, A1210, A2010, A2512, AxialCapacitor, BGA, ChipBody, type ChipBodyProps, Crystal, type CrystalProps, DFN, DPAK, type DPAKProps, Display, ElectrolyticCapacitor, type ElectrolyticCapacitorProps, ExtrudedPads, FPC, type FPCProps, FemaleHeader, FemaleHeaderRow, FootprintPad, FootprintPlatedHole, Footprinter3d, GullWingBody, type GullWingBodyProps, HC49, type HC49Props, JSTPH2_0mm, JSTZH1_5mm, LQFP, Led2835, type Led2835Props, Led5050, type Led5050Props, MELF, type MELFProps, MINIMELF, type MINIMELFProps, MS012, MS013, MSOP, MicroMELF, type MicroMELFProps, MountedPcbModule, PinHeader, PinRow, Potentiometer, type PotentiometerLead, type PotentiometerProps, QFN, QFP, RJ45, type RJ45Props, SMA, SMB, SMC, SMF, SOD123, SOD123F, SOD123FL, type SOD123Props, SOD123W, type SOD123WProps, SOD128, SOD323, SOD323F, SOD323FL, SOD523, SOD723, SOD882, SOD923, SOT223, type SOT223Props, SOT233P, SOT23W, SOT323, SOT363, SOT457, SOT563, SOT723, SOT886, SOT963, Screen, type ScreenProps, SmdChipLead, type SmdChipLeadProps, type SmdLeadPad, SmdPinHeader, type SmdPinHeaderProps, SmdPushButton, type SmdPushButtonProps, StampBoard, TO220, type TO220Lead, type TO220Props, TO92, type TO92Lead, type TO92Props, TQFP, Tssop, VSSOP };
+export { A01005, A0201, A0402, A0603, A0805, A1206, A1210, A2010, A2512, AxialCapacitor, BGA, ChipBody, type ChipBodyProps, Crystal, type CrystalProps, DFN, DPAK, type DPAKProps, Display, ElectrolyticCapacitor, type ElectrolyticCapacitorProps, ExtrudedPads, FPC, type FPCProps, FemaleHeader, FemaleHeaderRow, FlexScreen, type FlexScreenAspectRatio, type FlexScreenOrientation, type FlexScreenProps, FootprintPad, FootprintPlatedHole, Footprinter3d, GullWingBody, type GullWingBodyProps, HC49, type HC49Props, JSTPH2_0mm, JSTZH1_5mm, LQFP, Led2835, type Led2835Props, Led5050, type Led5050Props, MELF, type MELFProps, MINIMELF, type MINIMELFProps, MS012, MS013, MSOP, MicroMELF, type MicroMELFProps, MountedPcbModule, PinHeader, PinRow, Potentiometer, type PotentiometerLead, type PotentiometerProps, QFN, QFP, RJ45, type RJ45Props, type ResolvedFlexScreenSize, SMA, SMB, SMC, SMF, SOD123, SOD123F, SOD123FL, type SOD123Props, SOD123W, type SOD123WProps, SOD128, SOD323, SOD323F, SOD323FL, SOD523, SOD723, SOD882, SOD923, SOT223, type SOT223Props, SOT233P, SOT23W, SOT323, SOT363, SOT457, SOT563, SOT723, SOT886, SOT963, Screen, type ScreenProps, SmdChipLead, type SmdChipLeadProps, type SmdLeadPad, SmdPinHeader, type SmdPinHeaderProps, SmdPushButton, type SmdPushButtonProps, StampBoard, TO220, type TO220Lead, type TO220Props, TO92, type TO92Lead, type TO92Props, TQFP, Tssop, VSSOP, resolveFlexScreenSize };