ConstructionPlaneInput.setByPath Method

Description

This input method is for creating a construction plane normal to the specified path at a specified position along the path. 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

Python
C++
TypeScript 🧪

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByPath(path, distanceType, distance)

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

#include <Fusion/Construction/ConstructionPlaneInput.h>

returnValue = constructionPlaneInput_var->setByPath(path, distanceType, distance);

"constructionPlaneInput_var" is a variable referencing a ConstructionPlaneInput object.

returnValue = constructionPlaneInput_var.setByPath(path, distanceType, distance);

Parameters

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)).

distanceType

PathDistanceTypes

Specifies PathDistanceTypes value indicating the measurement type for distance.

distance

ValueInput

Specifies the distance to determine the position on the specified path to place the construction plane.

If the distanceType is set to ProportionalPathDistanceType this should be a unitless number from 0 to 1 indicating the proportion of the path. Values outside [0, 1] will cause this method to return false. This can be a real value or an expression which can be evaluated as a unitless number.

If the distanceType is set to PhysicalPathDistanceType this will be interpreted as a centimeter value if it is set using a real, or if an expression is provided it must be able to be evaluated as a valid distance. Values exceeding the total path length are clamped to the endpoint.

ConstructionPlaneInput.setByPath Method

Description

Syntax

Return Value

Parameters

Version

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

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)).
distanceType	PathDistanceTypes	Specifies PathDistanceTypes value indicating the measurement type for distance.
distance	ValueInput	Specifies the distance to determine the position on the specified path to place the construction plane. If the distanceType is set to ProportionalPathDistanceType this should be a unitless number from 0 to 1 indicating the proportion of the path. Values outside [0, 1] will cause this method to return false. This can be a real value or an expression which can be evaluated as a unitless number. If the distanceType is set to PhysicalPathDistanceType this will be interpreted as a centimeter value if it is set using a real, or if an expression is provided it must be able to be evaluated as a valid distance. Values exceeding the total path length are clamped to the endpoint.