brepjs API Reference
    Preparing search index...

    Interface WrappedFace

    Face wrapper — face introspection + 2D→3D transitions.

    interface WrappedFace {
        __wrapped: true;
        val: Face;
        apply<U extends AnyShape>(fn: (shape: Face) => U): Wrapped<U>;
        applyResult<U extends AnyShape>(fn: (shape: Face) => Result<U>): Wrapped<U>;
        area(): number;
        bounds(): Bounds3D;
        center(): Vec3;
        clone(): Wrapped<Face>;
        describe(): ShapeDescription;
        done(): Face;
        extrude(height: number | Vec3): Wrapped3D<Solid>;
        heal(): Wrapped<Face>;
        innerWires(): Wire[];
        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<Face>;
        moveX(distance: number): Wrapped<Face>;
        moveY(distance: number): Wrapped<Face>;
        moveZ(distance: number): Wrapped<Face>;
        normalAt(point?: Vec3): Vec3;
        outerWire(): Wire;
        revolve(
            options?: { angle?: number; around?: Vec3; axis?: Vec3 },
        ): Wrapped3D<Shape3D>;
        rotate(
            angle: number,
            options?: { around?: Vec3; axis?: Vec3 },
        ): Wrapped<Face>;
        rotateX(angle: number): Wrapped<Face>;
        rotateY(angle: number): Wrapped<Face>;
        rotateZ(angle: number): Wrapped<Face>;
        scale(factor: number, options?: { center?: Vec3 }): Wrapped<Face>;
        simplify(): Wrapped<Face>;
        surfaceType(): SurfaceType;
        toBREP(): string;
        translate(v: Vec3): Wrapped<Face>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    __wrapped val

    Methods

    apply applyResult area bounds center clone describe done extrude heal innerWires isEmpty isValid mesh meshEdges mirror moveX moveY moveZ normalAt outerWire revolve rotate rotateX rotateY rotateZ scale simplify surfaceType toBREP translate

    Properties

    Readonly__wrapped

    __wrapped: true

    Brand property to distinguish wrappers from branded shape handles.

    val: Face

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods