ConstructionPlaneInput.setByThreeSnapPoints Method

Parent Object: ConstructionPlaneInput
Defined in namespace "adsk::fusion" and the header file is <Fusion/Construction/ConstructionPlaneInput.h>

Description

This input method is for creating a construction plane through three snap points. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. Build each snap with ConstructionSnapPoint.create. Supported snap-point types include vertex (DefaultConstructionSnapPointType on a BRepVertex, SketchPoint, or ConstructionPoint), edge midpoint, edge start/end, arc center, face center, and tangent on a curved face (cylinder/cone, sphere, torus, or spline). The first snap point defines the plane origin. The three points together define the plane orientation (normal); they do not explicitly set the in-plane X- or Y-axis directions. This matches setByThreePoints. This will fail if the three points are collinear or any two are coincident. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component.

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByThreeSnapPoints(snapPointOne, snapPointTwo, snapPointThree)

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByThreeSnapPoints(snapPointOne, snapPointTwo, snapPointThree);

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByThreeSnapPoints(snapPointOne, snapPointTwo, snapPointThree);

Return Value

Type	Description
boolean	Returns true if the creation of the ConstructionPlaneInput is successful.

Parameters

Name	Type	Description
snapPointOne	ConstructionSnapPoint	The first ConstructionSnapPoint the plane passes through.
snapPointTwo	ConstructionSnapPoint	The second ConstructionSnapPoint the plane passes through.
snapPointThree	ConstructionSnapPoint	The third ConstructionSnapPoint the plane passes through.

Samples

Name Description

Construction Plane API Sample

Demonstrates creating construction planes using ConstructionPlaneInput: offset from a profile, angle, tangent, two planes, two edges, three points, three snap points, tangent at a point, and along a path. Also shows reading healthState, errorOrWarningMessage, and renaming planes.

Before running: No open document is required. The script creates a new design, sketches a circle and lines, extrudes a cylinder, then exercises the construction plane APIs on that model. Run from Scripts and Add-Ins (Python/C++/TypeScript) in the DESIGN workspace.

Version

Introduced in version September 2026