Class Sketch

constructor

• new Sketch(
      wire: ShapeHandle & { "[___brand]": "wire"; "[___dim]": "3D" } & {
          "[___closed]": true;
      } & { "[___planar]": true },
      __namedParameters?: {
          defaultDirection?: PointInput;
          defaultOrigin?: PointInput;
      },
  ): Sketch

  Parameters

  • wire: ShapeHandle & { "[___brand]": "wire"; "[___dim]": "3D" } & {
        "[___closed]": true;
    } & { "[___planar]": true }
  • __namedParameters: { defaultDirection?: PointInput; defaultOrigin?: PointInput } = {}

  Returns Sketch

wire

baseFace

• get baseFace(): Face | null | undefined

  Returns Face | null | undefined

• set baseFace(newFace: Face | null | undefined): void

  Parameters

  • newFace: Face | null | undefined

  Returns void

defaultDirection

• get defaultDirection(): Vec3

  Get the default extrusion/normal direction.

  Returns Vec3

• set defaultDirection(newDirection: PointInput): void

  Set the default extrusion/normal direction.

  Parameters

  • newDirection: PointInput

  Returns void

defaultOrigin

• get defaultOrigin(): Vec3

  Get the 3D origin used as default for extrusion and revolution.

  Returns Vec3

• set defaultOrigin(newOrigin: PointInput): void

  Set the 3D origin used as default for extrusion and revolution.

  Parameters

  • newOrigin: PointInput

  Returns void

clone

• clone(): Sketch

  Create an independent deep copy of this sketch.

  Returns Sketch

delete

• delete(): void

  Release all kernel resources held by this sketch.

  Returns void

extrude

• extrude(
      extrusionDistance: number,
      config?: {
          extrusionDirection?: PointInput;
          extrusionProfile?: ExtrusionProfile;
          origin?: PointInput;
          twistAngle?: number;
      },
  ): Shape3D

  Extrudes the sketch to a certain distance (along the default direction and origin of the sketch).

  You can define another extrusion direction or origin,

  It is also possible to twist extrude with an angle (in degrees), or to give a profile to the extrusion (the endFactor will scale the face, and the profile will define how the scale is applied (either linearly or with a s-shape).

  Parameters

  • extrusionDistance: number
  • config: {
        extrusionDirection?: PointInput;
        extrusionProfile?: ExtrusionProfile;
        origin?: PointInput;
        twistAngle?: number;
    } = {}

  Returns Shape3D

  Remarks

  Consumes the sketch — calling this twice throws on the second call.

face

• face(): Face

  Transforms the lines into a face. The lines should be closed.

  Returns Face

faces

• faces(): Face

  Alias for Sketch.face.

  Returns Face

loftWith

• loftWith(
      otherSketches: SketchInterface | SketchInterface[],
      loftConfig?: CleanLoftOptions,
      returnShell?: boolean,
  ): Shape3D

  Loft between this sketch and another sketch (or an array of them)

  You can also define a startPoint for the loft (that will be placed before this sketch) and an endPoint after the last one.

  You can also define if you want the loft to result in a ruled surface.

  Note that all sketches will be deleted by this operation

  Parameters

  • otherSketches: SketchInterface | SketchInterface[]
  • loftConfig: CleanLoftOptions = {}
  • returnShell: boolean = false

  Returns Shape3D

revolve

• revolve(revolutionAxis?: PointInput, config?: { origin?: PointInput }): Shape3D

  Revolves the drawing on an axis (defined by its direction and an origin (defaults to the sketch origin)

  Parameters

  • OptionalrevolutionAxis: PointInput
  • config: { origin?: PointInput } = {}

  Returns Shape3D

  Remarks

  Consumes the sketch — calling this twice throws on the second call.

sweepSketch

• sweepSketch(
      sketchOnPlane: (plane: Plane, origin: Vec3) => SketchInterface,
      sweepConfig?: SweepOptions,
  ): Shape3D

  Sweep along this sketch another sketch defined in the function sketchOnPlane.

  Parameters

  • sketchOnPlane: (plane: Plane, origin: Vec3) => SketchInterface
  • sweepConfig: SweepOptions = {}

  Returns Shape3D

  Remarks

  Consumes both this sketch and the one returned by sketchOnPlane — calling either consumer twice throws on the second call.

wires

• wires(): Wire

  Return a clone of the underlying wire.

  Returns Wire