brepjs API Reference
    Preparing search index...

    Interface KernelIOOps

    interface KernelIOOps {
        configureStepUnits(
            unit: string | undefined,
            modelUnit: string | undefined,
        ): void;
        configureStepWriter(writer: any): void;
        createXCAFDocument(
            shapes: {
                color?: [number, number, number, number];
                name: string;
                shape: any;
            }[],
        ): any;
        export3MF(shape: any, tolerance: number): ArrayBuffer;
        exportGLB(shape: any, tolerance: number): ArrayBuffer;
        exportIGES(shapes: any[]): string;
        exportOBJ(shape: any, tolerance: number): ArrayBuffer;
        exportPLY(shape: any, tolerance: number): ArrayBuffer;
        exportSTEP(shapes: any[]): string;
        exportSTEPAssembly(
            parts: StepAssemblyPart[],
            options?: { unit?: string },
        ): string;
        exportSTEPConfigured(
            shapes: {
                color?: [number, number, number, number];
                name?: string;
                shape: any;
            }[],
            options?: { modelUnit?: string; schema?: number; unit?: string },
        ): string;
        exportSTL(shape: any, binary?: boolean): string | ArrayBuffer;
        fromBREP(data: string): any;
        import3MF(data: ArrayBuffer): any[];
        importGLB(data: ArrayBuffer): any;
        importIGES(data: string | ArrayBuffer): any[];
        importOBJ(data: ArrayBuffer): any;
        importSTEP(data: string | ArrayBuffer): any[];
        importSTL(data: string | ArrayBuffer): any;
        toBREP(shape: any): string;
        wrapColor(red: number, green: number, blue: number, alpha: number): any;
        wrapString(str: string): any;
        writeXCAFToSTEP(
            doc: any,
            options?: { modelUnit?: string; unit?: string },
        ): string;
    }
    Index

    Methods

    configureStepUnits configureStepWriter createXCAFDocument export3MF exportGLB exportIGES exportOBJ exportPLY exportSTEP exportSTEPAssembly exportSTEPConfigured exportSTL fromBREP import3MF importGLB importIGES importOBJ importSTEP importSTL toBREP wrapColor wrapString writeXCAFToSTEP

    Methods

    • Configure STEP writer unit settings.

      Parameters

      • unit: string | undefined
      • modelUnit: string | undefined

      Returns void

    • Configure STEP writer standard settings (color, layer, name, schema).

      Parameters

      • writer: any

      Returns void

    • Create an XCAF document with named, colored shape nodes. Caller must delete the returned handle.

      Parameters

      • shapes: { color?: [number, number, number, number]; name: string; shape: any }[]

      Returns any

    • Export shape to 3MF format. Returns binary data.

      Parameters

      • shape: any
      • tolerance: number

      Returns ArrayBuffer

    • Export shape to GLB format. Returns binary data.

      Parameters

      • shape: any
      • tolerance: number

      Returns ArrayBuffer

    • Export shape to OBJ format. Returns binary data.

      Parameters

      • shape: any
      • tolerance: number

      Returns ArrayBuffer

    • Export shape to PLY format (binary). Returns binary data.

      Parameters

      • shape: any
      • tolerance: number

      Returns ArrayBuffer

    • Parameters

      • parts: StepAssemblyPart[]
      • Optionaloptions: { unit?: string }

      Returns string

    • Export shapes to STEP with full configuration (units, assembly mode).

      Parameters

      • shapes: { color?: [number, number, number, number]; name?: string; shape: any }[]
      • Optionaloptions: { modelUnit?: string; schema?: number; unit?: string }

      Returns string

    • Parameters

      • shape: any
      • Optionalbinary: boolean

      Returns string | ArrayBuffer

    • Import from 3MF format. Returns solid shapes.

      Parameters

      • data: ArrayBuffer

      Returns any[]

    • Serialize a shape to a string format for persistence.

      Cross-kernel warning: The serialization format is kernel-specific. OCCT uses its native BREP text format; brepkit proxies to STEP. Data produced by one kernel cannot be deserialized by the other.

      Parameters

      • shape: any

      Returns string

    • Create a kernel color from RGB 0-255 and alpha 0-1.

      Parameters

      • red: number
      • green: number
      • blue: number
      • alpha: number

      Returns any

    • Write an XCAF document to STEP format and return the string.

      Parameters

      • doc: any
      • Optionaloptions: { modelUnit?: string; unit?: string }

      Returns string

    Settings

    Member Visibility

    On This Page

    Methods