ConstructionPlaneInput.setByPathToObject 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 normal to the specified path at the position where the path meets the target point entity, with an optional signed offset along the path from that target. This can result in a parametric or non-parametric construction plane, depending on whether the parent design is parametric or is a direct edit component, or if the construction plane is created in a base feature in a parametric design.

Syntax

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByPathToObject(path, toObject, offset)
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByPathToObject(path, toObject, offset);
"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByPathToObject(path, toObject, offset);

Return Value

Type Description
boolean Returns true if calling this method is successful.

Parameters

Name Type Description
path Path Specifies the Path object the construction plane will be created on. To create a Path from a single BRepEdge or SketchCurve, use the static Path.create method (e.g. Path.create(edge, ChainedCurveOptions.noChainedCurves)).
toObject Base Specifies the point entity the construction plane is positioned to. This must be a BRepVertex, ConstructionPoint, or SketchPoint.
offset ValueInput Specifies the signed offset from the target along the path. Positive and negative values can be used to offset in both directions. Pass a value of 0 for no offset.

Version

Introduced in version September 2026