brepjs API Reference
    Preparing search index...

    Interface KernelTransformOps

    interface KernelTransformOps {
        circularPattern(
            shape: any,
            center: [number, number, number],
            axis: [number, number, number],
            angleStep: number,
            count: number,
        ): any[];
        composeTransform(
            ops: (
                | { type: "translate"; x: number; y: number; z: number }
                | {
                    angle: number;
                    axis?: readonly [number, number, number];
                    center?: readonly [number, number, number];
                    type: "rotate";
                }
            )[],
        ): { dispose: () => void; handle: any };
        generalTransform(
            shape: any,
            linear: readonly [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
            translation: readonly [number, number, number],
            isOrthogonal: boolean,
        ): any;
        generalTransformNonOrthogonal(
            shape: any,
            linear: readonly [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ],
            translation: readonly [number, number, number],
        ): any;
        gridPattern?(
            shape: any,
            directionX: [number, number, number],
            directionY: [number, number, number],
            spacingX: number,
            spacingY: number,
            countX: number,
            countY: number,
        ): any;
        linearPattern(
            shape: any,
            direction: [number, number, number],
            spacing: number,
            count: number,
        ): any[];
        locate(shape: any, trsf: any): any;
        mirror(
            shape: any,
            origin: readonly [number, number, number],
            normal: readonly [number, number, number],
        ): any;
        positionOnCurve(shape: any, spine: any, param: number): any;
        rotate(
            shape: any,
            angle: number,
            axis?: readonly [number, number, number],
            center?: readonly [number, number, number],
        ): any;
        scale(
            shape: any,
            center: readonly [number, number, number],
            factor: number,
        ): any;
        transform(shape: any, trsf: any): any;
        transformBatch(entries: TransformEntry[]): any[];
        translate(shape: any, x: number, y: number, z: number): any;
    }
    Index

    Methods

    circularPattern composeTransform generalTransform generalTransformNonOrthogonal gridPattern? linearPattern locate mirror positionOnCurve rotate scale transform transformBatch translate

    Methods

    • Generate a circular pattern of shapes.

      Parameters

      • shape: any
      • center: [number, number, number]
      • axis: [number, number, number]
      • angleStep: number
      • count: number

      Returns any[]

    • Create a composed transform from a sequence of translate/rotate operations. Returns an opaque handle.

      Parameters

      • ops: (
            | { type: "translate"; x: number; y: number; z: number }
            | {
                angle: number;
                axis?: readonly [number, number, number];
                center?: readonly [number, number, number];
                type: "rotate";
            }
        )[]

      Returns { dispose: () => void; handle: any }

    • Parameters

      • shape: any
      • linear: readonly [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
      • translation: readonly [number, number, number]
      • isOrthogonal: boolean

      Returns any

    • Apply a non-orthogonal general transform (gp_GTrsf path for shear / non-uniform scale).

      Parameters

      • shape: any
      • linear: readonly [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
      • translation: readonly [number, number, number]

      Returns any

    • Generate a 2D grid pattern (brepkit-native). Returns a compound.

      Parameters

      • shape: any
      • directionX: [number, number, number]
      • directionY: [number, number, number]
      • spacingX: number
      • spacingY: number
      • countX: number
      • countY: number

      Returns any

    • Generate a linear pattern of shapes with pooled transforms for performance.

      Parameters

      • shape: any
      • direction: [number, number, number]
      • spacing: number
      • count: number

      Returns any[]

    • Apply a rigid transform as a location re-tag that shares the source's underlying geometry instead of deep-copying its topology — O(1) vs O(topology size). trsf MUST be a rigid motion (rotation + translation, e.g. built from translate/rotate via composeTransform); non-rigid input (scale/shear) is unsupported. Kernels with no cheap-location concept fall back to a copying transform: the result is geometrically identical, only the cost differs.

      Parameters

      • shape: any
      • trsf: any

      Returns any

    • Parameters

      • shape: any
      • origin: readonly [number, number, number]
      • normal: readonly [number, number, number]

      Returns any

    • Position a shape at a parameter along a spine curve (Frenet frame transform).

      Parameters

      • shape: any
      • spine: any
      • param: number

      Returns any

    • Parameters

      • shape: any
      • angle: number
      • Optionalaxis: readonly [number, number, number]
      • Optionalcenter: readonly [number, number, number]

      Returns any

    • Parameters

      • shape: any
      • center: readonly [number, number, number]
      • factor: number

      Returns any

    Settings

    Member Visibility

    On This Page

    Methods