brepjs API Reference
    Preparing search index...

    Interface Wrapped<T>

    Base wrapper — available on all shapes.

    interface Wrapped<T extends AnyShape> {
        __wrapped: true;
        val: T;
        apply<U extends AnyShape>(fn: (shape: T) => U): Wrapped<U>;
        applyResult<U extends AnyShape>(fn: (shape: T) => Result<U>): Wrapped<U>;
        bounds(): Bounds3D;
        clone(): Wrapped<T>;
        describe(): ShapeDescription;
        done(): T;
        heal(): Wrapped<T>;
        isEmpty(): boolean;
        isValid(): boolean;
        mesh(
            options?: MeshOptions & {
                cache?: boolean;
                includeUVs?: boolean;
                skipNormals?: boolean;
            },
        ): ShapeMesh;
        meshEdges(options?: MeshOptions & { cache?: boolean }): EdgeMesh;
        mirror(options?: { normal?: Vec3; origin?: Vec3 }): Wrapped<T>;
        moveX(distance: number): Wrapped<T>;
        moveY(distance: number): Wrapped<T>;
        moveZ(distance: number): Wrapped<T>;
        rotate(angle: number, options?: { around?: Vec3; axis?: Vec3 }): Wrapped<T>;
        rotateX(angle: number): Wrapped<T>;
        rotateY(angle: number): Wrapped<T>;
        rotateZ(angle: number): Wrapped<T>;
        scale(factor: number, options?: { center?: Vec3 }): Wrapped<T>;
        simplify(): Wrapped<T>;
        toBREP(): string;
        translate(v: Vec3): Wrapped<T>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    __wrapped val

    Methods

    apply applyResult bounds clone describe done heal isEmpty isValid mesh meshEdges mirror moveX moveY moveZ rotate rotateX rotateY rotateZ scale simplify toBREP translate

    Properties

    Readonly__wrapped

    __wrapped: true

    Brand property to distinguish wrappers from branded shape handles.

    val: T

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods