brepjs API Reference
    Preparing search index...

    Interface ConstraintSketchCapability

    Capability for 2D constraint sketch solving.

    interface ConstraintSketchCapability {
        sketchAddArc(
            sketch: number,
            centerIdx: number,
            startIdx: number,
            endIdx: number,
        ): number;
        sketchAddConstraint(sketch: number, constraintJson: string): void;
        sketchAddPoint(
            sketch: number,
            x: number,
            y: number,
            fixed: boolean,
        ): number;
        sketchDof(sketch: number): string;
        sketchNew(): number;
        sketchSolve(
            sketch: number,
            maxIterations: number,
            tolerance: number,
        ): string;
    }
    Index

    Methods

    sketchAddArc sketchAddConstraint sketchAddPoint sketchDof sketchNew sketchSolve

    Methods

    • Add an arc entity to a constraint sketch. Returns the arc index.

      Parameters

      • sketch: number
      • centerIdx: number
      • startIdx: number
      • endIdx: number

      Returns number

    • Add a constraint to a sketch (JSON-encoded constraint descriptor).

      Parameters

      • sketch: number
      • constraintJson: string

      Returns void

    • Add a point to a constraint sketch. Returns the point index.

      Parameters

      • sketch: number
      • x: number
      • y: number
      • fixed: boolean

      Returns number

    • Get degrees of freedom remaining in a constraint sketch. Returns JSON string.

      Parameters

      • sketch: number

      Returns string

    • Create a new constraint sketch. Returns an opaque sketch handle.

      Returns number

    • Solve sketch constraints. Returns a JSON result with solved point positions.

      Parameters

      • sketch: number
      • maxIterations: number
      • tolerance: number

      Returns string

    Settings

    Member Visibility

    On This Page

    Methods