Class Sketches

constructor

• new Sketches(sketches: (Sketch | CompoundSketch)[]): Sketches

  Parameters

  • sketches: (Sketch | CompoundSketch)[]

  Returns Sketches

sketches

extrude

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

  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
  • extrusionConfig: {
        extrusionDirection?: PointInput;
        extrusionProfile?: ExtrusionProfile;
        origin?: PointInput;
        twistAngle?: number;
    } = {}

  Returns Compound

face

• face(): Face

  Build a face from the sole contained profile (see Sketches.faces).

  Returns Face

faces

• faces(): Compound

  Return all sketch faces combined into a single compound shape.

  Returns Compound

loftWith

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

  Loft from the sole contained profile to one or more other sketches.

  Parameters

  • otherSketches: SketchInterface | SketchInterface[]
  • OptionalloftConfig: CleanLoftOptions
  • OptionalreturnShell: boolean

  Returns Shape3D

revolve

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

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

  Parameters

  • OptionalrevolutionAxis: PointInput
  • Optionalconfig: { origin?: PointInput }

  Returns Compound

sweepSketch

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

  Sweep a profile along the sole contained sketch's wire.

  Parameters

  • sketchOnPlane: (plane: Plane, origin: Vec3) => SketchInterface
  • OptionalsweepConfig: SweepOptions

  Returns Shape3D

wires

• wires(): Compound

  All contour wires combined into a single compound shape.

  Returns Compound

  Remarks

  Allocates a fresh compound on every call — the result is a caller-owned kernel resource. Dispose it (using/Symbol.dispose) or it leaks an arena slot on arena kernels.